The MIB module defines the managed objects for Telepresence calls.
Telepresence refers to a set of technologies which allow a person to feel as if they were present, to give the appearance that they were present, or to have an effect, at a location other than their true location.
Telepresence call is an audio-video call; however, some Telepresence systems also support audio addin call.
Different security levels are supported in some Telepresence systems; security level may be specified from call management system.
Some Telepresence systems support Telepresence meeting, the agent of the corresponding systems may also support CISCO-TELEPRESENCE-MEETING-MIB.
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object controls generation of notifications for the real-time call statistics data monitoring.
Call statistics monitoring threshold can be set by creating a corresponding ctpcStatMonitoredEntry. Notification will be generated based on the value of the ctpcStatStartupAlarm and the thresholds.
When the object is 'true', the agent will generate notification when the monitoring threshold is crossed.
When the object is 'false', the agent will not generate notification when the monitoring threshold is crossed.
ctpcMgmtSysConnNotifyEnable
1.3.6.1.4.1.9.9.644.1.1.2
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object controls generation of notifications for call management system connection state changes.
When the object is 'true', the agent will generate notification when call management system connection state changes.
When the object is 'false', the agent will not generate notification when call management system connection state changes.
ctpcLocalAddrType
1.3.6.1.4.1.9.9.644.1.2.1
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
This object specifies the type of address contained in the corresponding instance of ctpcLocalAddr.
ctpcLocalAddr
1.3.6.1.4.1.9.9.644.1.2.2
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
This object specifies the address of the system in the format given by the corresponding instance of ctpcLocalAddrType.
ctpcMode
1.3.6.1.4.1.9.9.644.1.2.4
INTEGER1 = noMgmtSys2 = mgmtSys · Integer32
This object specifies the system configured call mode. It indicates if the call is processed by call management system or not.
nonMgmtSys(1) -- Telepresence system that does not connect to any call management system such as Cisco Unified Communication Manager (CUCM).
mgmtSys (2) --
Telepresence system that connects to a call management system.
Note that some Telepresence systems support 'mgmtSys' only.
ctpcActiveMgmtSysIndex
1.3.6.1.4.1.9.9.644.1.2.5
Unsigned32
This object specifies the value of ctpcMgmtSysIndex which the Telepresence system currently connects.
If the system is in 'nonMgmtSys' mode, this object will have value '0'
ctpcTxDscpTelepresenceConfigured
1.3.6.1.4.1.9.9.644.1.2.7
DscpA Differentiated Services Code-Point that may be used for marking a traffic stream.Reference: RFC 2474, RFC 2780 (0..63) · Integer32 · hint d
This object specifies the configured DSCP for all outgoing streams for a Telepresence call.
ctpcTxDscpAudioConfigured
1.3.6.1.4.1.9.9.644.1.2.8
DscpA Differentiated Services Code-Point that may be used for marking a traffic stream.Reference: RFC 2474, RFC 2780 (0..63) · Integer32 · hint d
This object specifies the configured DSCP for outgoing streams for audio-only call.
ctpcStatOverallCalls
1.3.6.1.4.1.9.9.644.1.4.1
Unsigned32
This object specifies total number of calls since Telepresence system was first in service.
When it reaches a maximum value of 2^32-1 (4294967295 decimal), it wraps around and starts increasing again from '1'.
ctpcStatOverallCallTime
1.3.6.1.4.1.9.9.644.1.4.2
Unsigned32 · seconds
This object specifies elapsed time of calls since Telepresence system was first in service.
When it reaches a maximum value of 2^32-1 (4294967295 decimal), it wraps around and starts increasing again from '1'.
ctpcStatTotalCalls
1.3.6.1.4.1.9.9.644.1.4.3
Unsigned32
This object specifies total number of calls since Telepresence system was last rebooted.
When it reaches a maximum value of 2^32-1 (4294967295 decimal), it wraps around and starts increasing again from '1'.
ctpcStatTotalCallTime
1.3.6.1.4.1.9.9.644.1.4.4
Unsigned32 · seconds
This object specifies elapsed time of calls since Telepresence system was last rebooted.
When it reaches a maximum value of 2^32-1 (4294967295 decimal), it wraps around and starts increasing again from '1'.
ctpcSamplePeriod
1.3.6.1.4.1.9.9.644.1.4.5
Unsigned32 (10..300) · seconds
This object specifies a sample period by which the following objects are based on:
ctpcAvgPeriodLatency, ctpcMaxPeriodLatency, ctpcTxPeriodLostPackets, ctpcRxPeriodLostPackets, ctpcAvgPeriodJitter, ctpcMaxPeriodJitter
ctpcTableSize
1.3.6.1.4.1.9.9.644.1.4.6
Integer32 (-1..500)
This object specifies the maximum number of entries of the ctpcTable.
Some agents restrict the maximum value of this object to be less than 500.
When the capacity of the ctpcTable has reached the value specified by this object, then the agent deletes the oldest entry in order to accommodate the new entry.
When this object is set to '-1', ctpcTableSize will not set maximum entries that ctpcTable is contained.
The table size in turns may be limited by the associated MIB such as CISCO-TELEPRESENCE-MEETING-MIB.
ctpcTableLastIndex
1.3.6.1.4.1.9.9.644.1.4.7
Unsigned32
This object specifies the value of the ctpcIndex object corresponding to the last entry added to the table.
When it reaches a maximum value of 2^32-1 (4294967295 decimal), it wraps around and starts increasing again from '1'.
ctpcStatEventHistTableSize
1.3.6.1.4.1.9.9.644.1.5.1
Unsigned32 (0..500)
This object specifies the number of entries that the ctpcStatEventHistoryTable can contain. When the capacity of the ctpcStatEventHistoryTable has reached, the value specified by this object, then the agent deletes the oldest entry in order to accommodate the new entry. A value of '0' prevents any history from being retained.
ctpcStatEventHistLastIndex
1.3.6.1.4.1.9.9.644.1.5.2
Unsigned32
This object specifies the value of the ctpcStatEventHistIndex object corresponding to the last entry added to the table by the agent.
If the management client uses the notifications defined by this module, then it can poll this object to determine whether it has missed a notification sent by the agent.
ctpcMgmtSysConnEventHistTableSize
1.3.6.1.4.1.9.9.644.1.6.1
Unsigned32 (0..500)
This object specifies the number of entries that the ctpcMgmtSysConnEventHistoryTable can contain. When the capacity of the ctpcMgmtSysConnEventHistoryTable has reached, the value specified by this object, then the agent deletes the oldest entry in order to accommodate the new entry. A value of '0' prevents any history from being retained.
Some agents restrict the maximum value of this object to be less than 500.
ctpcMgmtSysConnEventHistLastIndex
1.3.6.1.4.1.9.9.644.1.6.2
Unsigned32
This object specifies the value of the ctpcMgmtSysConnEventHistIndex object corresponding to the last entry added to the table by the agent.
If the management client uses the notifications defined by this module, then it can poll this object to determine whether it has missed a notification sent by the agent.
Table details
ctpcLocalDirNumTable
1.3.6.1.4.1.9.9.644.1.2.3
Index: ctpcLocalDirNumIndex
A table of information about E.164 numbers assigned to the Telepresence system.
The directory numbers usually are specified by the call management system.
Some Telepresence systems have only one E.164 number assigned.
ctpcLocalDirNumIndex
1.3.6.1.4.1.9.9.644.1.2.3.1.1
Unsigned32
The object specifies a unique index for a local directory number entry associates to the system.
ctpcLocalDirNum
1.3.6.1.4.1.9.9.644.1.2.3.1.2
CtpcE164AddressA UTF-8 string limited to the character set defined for E.164, '0123456789*#,<quote>'. Note that <quote> represents the double quote which cannot be contained in a SMI description clause.Reference: ITU-T E.164 SIZE (1..32) · OCTET STRING · hint 32t
This object specifies the directory number of the Telepresence system.
ctpcExtNumberMask
1.3.6.1.4.1.9.9.644.1.2.3.1.3
SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form.
To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279].
Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited.
The use of control codes should be avoided.
When it is necessary to represent a newline, the control code sequence CR LF should be used.
The use of leading or trailing white space should be avoided.
For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided.
For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding.
UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding.
Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object indicates the external number mask that configured in the management system. For example, if ctpcExtNumberMask is configured as 9728XXXXX, and ctpcLocalDirNum is configured as 12345, the external caller shall see the Directory Number (DN) as 972812345
ctpcMgmtSysTable
1.3.6.1.4.1.9.9.644.1.2.6
Index: ctpcMgmtSysIndex
A table of configured call management systems.
ctpcMgmtSysIndex
1.3.6.1.4.1.9.9.644.1.2.6.1.1
Unsigned32 (1..4294967295)
This object specifies a unique index for a call management system entry.
ctpcMgmtSysAddrType
1.3.6.1.4.1.9.9.644.1.2.6.1.2
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
This object specifies the type of address contained in the corresponding instance of ctpcMgmtSysAddr.
ctpcMgmtSysAddr
1.3.6.1.4.1.9.9.644.1.2.6.1.3
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
This object specifies a call management system address which a Telepresence system can connect to if it is in 'mgmtSys' mode.
It is in the format given by the corresponding instance of ctpcMgmtSysAddrType.
ctpcMgmtSysConnStatus
1.3.6.1.4.1.9.9.644.1.2.6.1.4
CtpcMgmtSysConnStatusCode1 = unknown2 = other3 = internalError4 = notRegister5 = registered6 = registraionFailureThe textual convention identifies the management system connection status.
unknown (1) --
Call management system connection status is unknown.
other (2) --
Call management system connection status is not listed.
internalError (3) --
Telepresence system has internal system error to return call management system connection status.
notRegister (4) --
Telepresence system is not register to the call management system.
registered (5) --
Telepresence registered to a call management system. registrationFailure (6) -- Call management system registration failed. · Integer32
This object specifies the last connection state between the Telepresence and a call management system.
ctpcMgmtSysSIPRespCode
1.3.6.1.4.1.9.9.644.1.2.6.1.5
Unsigned32
Reference: RFC 3261, section 21
This object specifies the last SIP response code from call management system.
A table of configuration information for the monitoring of statistics of active Telepresence calls.
The monitoring feature has a hysteresis mechanism to limit the generation of events. This mechanism generates one event as a threshold is crossed in the appropriate direction. No more events are generated for that threshold until the opposite threshold is crossed.
ctpcStatMonitoredType
1.3.6.1.4.1.9.9.644.1.3.1.1.1
CtpcStatMonitoredAttribute1 = latency2 = jitter3 = packetLoss4 = authFailurePacketThe textual convention identifies the monitoring type for a Telepresence call.
latency (1) --
Round trip latency measurement.
jitter (2) --
Jitter of incoming and/or outgoing frames.
packetLoss (3) --
Percentage of packet loss for the incoming and/or outgoing packets. authFailurePacket (4) -- Number of packets which has Secured Real-Time Protocol (SRTP) or Secured Real-Time Control Protocol (SRTCP) authentication failure. · Integer32
This object specifies a statistical attribute which to be monitored.
ctpcStatMonitoredStreamType
1.3.6.1.4.1.9.9.644.1.3.1.1.2
INTEGER0 = all1 = video2 = audio · Integer32
This object specifies a active Telepresence stream type which to be monitored.
If the value of this object is 'all', all stream types are monitored with the corresponding ctpcStatRisingThreshold and/or ctpcStatFallingThreshold for ctpcStatMonitoredType.
Moreover, if this value is 'all', there cannot be another row for the same value of ctpcStatMonitoredType which is either 'video' or 'audio'.
If ctpcStatMonitoredType has value latency(1) or authFailurePacket(4), this object will have value '0'.
Note that some Telepresence systems may not support different thresholds for different stream type.
ctpcStatMonitoredUnit
1.3.6.1.4.1.9.9.644.1.3.1.1.3
CtpcStatMonitoredAttributeUnit1 = milliseconds2 = micropercent3 = packetsThe textual convention identifies a Telepresence call monitoring type's measuring unit which is milliseconds, micropercent (10^-6 percent) or number of packets. · Integer32
This object specifies the corresponding unit of a monitoring attribute.
The following table lists the possible values of this object, given the value of the corresponding instance of ctpcStatMonitoredType.
ctpcStatMonitoredType ctpcStatMonitoredUnit
----------------------------------------------------
latency(1) milliseconds(1)
jitter(2) milliseconds(1)
packetLoss(3) micropercent(2)
authFailurePacket(4) packets(3)
ctpcStatRisingThreshold
1.3.6.1.4.1.9.9.644.1.3.1.1.4
Unsigned32
This object specifies the rising threshold of a monitoring attribute.
When the call period value of the corresponding attribute is greater than or equal to this threshold, a single event will be generated. A single event will also be generated if the first call period value of the corresponding attribute after this entry becomes 'active' is greater than or equal to this threshold and the associated ctpcStatStartupAlarm is equal to risingAlarm(1) or risingOrFallingAlarm(3).
After a rising event is generated, another such event will not be generated until the call period value of the corresponding attribute falls below this threshold and reaches the corresponding ctpcStatFallingThreshold.
If this object is not specified when the row is created, default value based on the value of the corresponding instance of ctpcStatMonitoredType may be set by the agent.
This object may not be modified if the associated ctpcStatMonitoredStatus object is equal to active(1).
ctpcStatFallingThreshold
1.3.6.1.4.1.9.9.644.1.3.1.1.5
Unsigned32
This object specifies the falling threshold of a monitoring attribute.
When the call period value of the corresponding attribute is less than or equal to this threshold, [ and the value at the last sampling interval was greater than this threshold, ] a single event will be generated. A single event will also be generated if the first call period value of the corresponding attribute after this entry becomes 'active' is less than or equal to this threshold and the associated ctpcStatStartupAlarm is equal to fallingAlarm(1) or risingOrFallingAlarm(3).
After a falling event is generated, another such event will not be generated until the call period value of the corresponding attribute rises above this threshold and reaches the corresponding ctpcStatRisingThreshold.
If this object is not specified when the row is created, default value based on the value of the corresponding instance of ctpcStatMonitoredType may be set by the agent.
This object may not be modified if the associated ctpcStatMonitoredStatus object is equal to active(1).
ctpcStatStartupAlarm
1.3.6.1.4.1.9.9.644.1.3.1.1.6
CtpcStatAlarmMode1 = risingAlarm2 = fallingAlarm3 = risingOrFallingAlarmThe textual convention identifies the monitoring alarm mode.
risingAlarm (1) --
Alarm will be generated if first sample is greater than or equal to rising threshold.
fallingAlarm (2) --
Alarm will be generated if first sample is less than or equal to falling threshold. risingOrFallingAlarm (3) -- Alarm will be generated if first sample is greater than or equal to rising threshold or less than or equal to falling threshold. · Integer32
This object specifies the alarm that may be sent after the entry is first set to valid.
If the first sample after this entry becomes valid is greater than or equal to the ctpcStatRisingThreshold and ctpcStatStartupAlarm is equal to risingAlarm(1) or risingOrFallingAlarm(3), then a single rising alarm will be generated.
If the first sample after this entry becomes valid is less than or equal to the ctpcStatFallingThreshold and ctpcStatStartupAlarm is equal to fallingAlarm(2) or risingOrFallingAlarm(3), then a single falling alarm will be generated.
This object may not be modified if the associated ctpcStatMonitoredStatus object is equal to active(1).
ctpcStatMonitoredStatus
1.3.6.1.4.1.9.9.644.1.3.1.1.7
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object specifies the status of ctpcStatMonitoredEntry. Once the entry status is set to 'active', the call statistics monitoring will be started.
If this object is set to 'notInService' or 'destroy', the monitoring will be disabled to the corresponding stream type on the corresponding monitoring attribute.
ctpcTable
1.3.6.1.4.1.9.9.644.1.4.8
Index: ctpcIndex
A table for Telepresence call information.
After management system initialization (i.e. when sysUpTime is reset to zero), this table records all calls until it reaches its capacity specifed in ctpcTableSize. Thereafter, it remains full by retaining the most recent calls information.
ctpcIndex
1.3.6.1.4.1.9.9.644.1.4.8.1.1
Unsigned32 (1..4294967295)
This object specifies a unique identification of a call entry.
If the chosen ctpcIndex value for the row creation is already in use by an existing entry, SNMP SetRequest to the ctpcIndex value will fail.
ctpcRemoteDirNum
1.3.6.1.4.1.9.9.644.1.4.8.1.2
CtpcE164AddressA UTF-8 string limited to the character set defined for E.164, '0123456789*#,<quote>'. Note that <quote> represents the double quote which cannot be contained in a SMI description clause.Reference: ITU-T E.164 SIZE (1..32) · OCTET STRING · hint 32t
This object specifies the remote directory number of a call.
Once the ctpcRowStatus is set to 'active', the ctpcRemoteDirNum cannot be changed.
ctpcLocalSIPCallId
1.3.6.1.4.1.9.9.644.1.4.8.1.3
SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form.
To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279].
Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited.
The use of control codes should be avoided.
When it is necessary to represent a newline, the control code sequence CR LF should be used.
The use of leading or trailing white space should be avoided.
For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided.
For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding.
UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding.
Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
This object specifies the address type of the corresponding instance of ctpcTxDestAddr.
ctpcTxDestAddr
1.3.6.1.4.1.9.9.644.1.4.8.1.5
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
This object specifies the address of the media packets forwarded to in the format given by the corresponding instance of ctpcTxDestAddrType.
ctpcStartDateAndTime
1.3.6.1.4.1.9.9.644.1.4.8.1.6
DateAndTimeA date-time specification.
field octets contents range
----- ------ -------- -----
1 1-2 year* 0..65536
2 3 month 1..12
3 4 day 1..31
4 5 hour 0..23
5 6 minutes 0..59
6 7 seconds 0..60
(use 60 for leap-second)
7 8 deci-seconds 0..9
8 9 direction from UTC '+' / '-'
9 10 hours from UTC* 0..13
10 11 minutes from UTC 0..59
* Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13
For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as:
1992-5-26,13:30:15.0,-4:0
Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d
This object specifies the value of local date and time when a call is started.
ctpcDuration
1.3.6.1.4.1.9.9.644.1.4.8.1.7
Unsigned32 · seconds
This object specifies the elapsed time since the call established.
This object specifies the call type.
audioVideo (1) -- Telepresence call.
audioOnly (2) -- Audio call.
unknown (3) -- The system cannot detect the type of a call.
Some Telepresence systems only support audio-video call.
This object specifies the call security level.
nonSecured (1) --
Neither media packets nor signaling packets are encrypted. authenticated (2) -- Signaling packets are authenticated and/or encrypted but not the media packets.
secured (3) --
Both media packets and signaling packets are encrypted.
unknown (4) --
Cannot detect the security state of a call.
This object specifies the call direction.
incoming (1) -- The system received a call. outgoing (2) -- The system initiated a call.
unknown (3) -- The system cannot detect the direction
-- of a call.
ctpcState
1.3.6.1.4.1.9.9.644.1.4.8.1.11
CtpcStateCode1 = unknown2 = other3 = noMgmtSysConn4 = noDialTone5 = invalidNumber6 = ringing7 = noAnswer8 = inProgress9 = remoteHold10 = shareLineActive11 = inLocalConference12 = terminatedbyError13 = localHold14 = terminatedNormally15 = answer16 = resume17 = busy18 = pause19 = playback20 = recordingThe textual convention identifies a call state.
unknown (1) --
The system does not know what state that the call is in.
other (2) --
The call is in a state not listed.
noMgmtSysConn (3) --
The call cannot be dialed out due to no call management system connection. It is applicable only if the system is in 'mgmtSys' mode.
noDialTone (4) --
The call cannot be dialed out due to no line is available.
invalidNumber (5) --
The directory number of the remote party is invalid.
ringing (6) --
The call is waiting to be answered.
noAnswer (7) --
The call is not answered.
inProgress (8) --
The call is in progress.
remoteHold (9) --
The call is on hold by remote party.
shareLineActive (10) --
The call is being picked up by other share line device.
inLocalConference (11) --
The call is in local conference mode.
terminatedByError (12) --
The call is terminated because of error.
localHold (13) --
The call is on hold by local party. terminatedNormally (14) -- The call is terminated normally.
answer (15) --
Answer an incoming call.
resume (16) --
Resume a call from local hold.
busy (17) --
The call is not answered due to remote busy.
pause (18) --
Put the call in pause mode, no video and audio streams will be received.
playback (19) --
The call is in playback state.
recording (20) --
The call is being recorded. · Integer32
This object specifies the call state.
ctpcInitialBitRate
1.3.6.1.4.1.9.9.644.1.4.8.1.12
Unsigned32 · kbps
This object specifies the initial bit rate of a Telepresence call.
ctpcLatestBitRate
1.3.6.1.4.1.9.9.644.1.4.8.1.13
Unsigned32 · kbps
This object specifies the current bit rate of a call.
Telepresence call's bit rate may be lowered automatically due to network congestion.
ctpcRowStatus
1.3.6.1.4.1.9.9.644.1.4.8.1.14
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object specifies the entry status of ctpcEntry. Once ctpcRowStatus is set to 'active', the call creation cannot be stopped.
Changing the value of this object from 'active' to 'notInService' or 'destroy' will likely have consequences of call termination and/or losing the call statistics information. Thus, write access to this object is inappropriate for most of the Telepresence systems, and many implementations will choose not to support write-access for this object.
ctpcAttributes
1.3.6.1.4.1.9.9.644.1.4.8.1.15
CtpcAttributesThe textual convention identifies the attributes or characteristics of a call.
interop (0) --
The call involves at least one interop party. highDefinitionInterop (1) -- The call involves at least one high definition interop party.
webEx (2) --
The call involves at least one WebEx party.
schedule (3) --
This call is a scheduled call. satellite (4) -- This call is going through satellite connection.
t1 (5) --
This call is going through T1 connection.
liveDesk (6) --
This call is calling to live desk. · BITS
This object specifies the connection mode of a call.
ctpcRemoteDevice
1.3.6.1.4.1.9.9.644.1.4.8.1.16
CtpcRemoteDeviceType1 = unknown2 = other3 = audioDevice4 = videoLegacyDevice5 = highDefinitionLegacyDevice6 = singleTelepresence7 = tripleTelepresence8 = telepresenceMultipointSwitch9 = telepresenceRecordingServer10 = telepresenceTranscodingDeviceThe textual convention identifies the remote device type of a call.
unknown (1) --
The remote device type is not known.
other (2) --
The remote device type is not listed.
audioDevice (3) --
Audio device.
videoLegacyDevice (4) --
Video device which is sending legacy stream.
highDefinitionLegacyDevice (5) --
Video device which is sending high definition legacy stream.
singleTelepresence (6) --
Telepresence device which is sending single video stream.
tripleTelepresence (7) --
Telepresence device which is sending three video streams.
telepresenceMultipointSwitch (8) --
Telepresence Multipoint Switch.
telepresenceRecordingServer (9) --
Telepresence Recording Server. telepresenceTranscodingDevice(10) -- Telepresence Transcoding Device. · Integer32
This object specifies the remote device type.
ctpcCallTermReason
1.3.6.1.4.1.9.9.644.1.4.8.1.17
CtpcCallTerminationCode1 = unknown2 = other3 = internalError4 = localDisconnected5 = remoteDisconnected6 = networkCongestion7 = mediaNegotiationFailure8 = securityConfigMismatched9 = incompatibleRemoteEndPt10 = serviceUnavailable11 = remoteTerminatedWithError12 = incallThe textual convention identifies a call termination reason.
unknown (1) --
Call termination reason is unknown.
other (2) --
Call termination reason is not listed.
internalError (3) --
Telepresence system has internal system error to return call termination reason.
localDisconnected (4) --
Call is terminated due to local user disconnected. remoteDisconnected (5) -- Call is terminated due to remote user disconnected.
networkCongestion (6) --
Call is terminated due to network congestion. mediaNegotiationFailure (7) -- Call is terminated due to media negotiation failure. securityConfigMismatched (8) -- Call is terminated due to security configuration mismatched. incompatibleRemoteEndPt (9) -- Call is terminated due to incompatible remote end point. serviceUnavailable (10) -- Call cannot be routed due to service unavailable. remoteTerminatedWithError (11) -- Call is terminated due to remote end point termination with error.
incall (12) --
Call is not terminated yet. · Integer32
This object specifies the call termination reason.
ctpcStatStreamTypeTable
1.3.6.1.4.1.9.9.644.1.4.9
Index: ctpcIndex · ctpcStreamType
A table of stream type information of a call.
ctpcStreamType
1.3.6.1.4.1.9.9.644.1.4.9.1.1
CtpcStreamMediaType1 = video2 = audio3 = contentThis textual convention identifies a call stream type. A Telepresence call has two media streams, video and audio while an audio add-in call only has one media stream, audio.
video (1) -- Video stream of a call. audio (2) -- Audio stream of a call. content(3)-- Content stream of a call, such as presentation · Integer32
This object specifies the call stream type.
ctpcAvgPeriodLatency
1.3.6.1.4.1.9.9.644.1.4.9.1.2
Gauge32 · milliseconds
This object specifies the average latency for the last sample period specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcAvgCallLatency
1.3.6.1.4.1.9.9.644.1.4.9.1.3
Gauge32 · milliseconds
This object specifies the average latency for the duration of a call.
ctpcMaxPeriodLatency
1.3.6.1.4.1.9.9.644.1.4.9.1.4
Gauge32 · milliseconds
This object specifies the maximum latency among all the sample periods.
ctpcMaxCallLatency
1.3.6.1.4.1.9.9.644.1.4.9.1.5
Gauge32 · milliseconds
This object specifies the maximum latency for the duration of a call.
ctpcMaxCallLatencyRecTime
1.3.6.1.4.1.9.9.644.1.4.9.1.6
Unsigned32 · seconds
This object specifies the elapsed time since the call is established when the maximum latency of a call is recorded.
ctpcMediaSrcPort
1.3.6.1.4.1.9.9.644.1.4.9.1.7
Unsigned32
This object specifies the source port to transmit and receive the media.
ctpcMediaDestPort
1.3.6.1.4.1.9.9.644.1.4.9.1.8
Unsigned32
This object specifies the dest port to transmit and receive the media.
ctpcRxDscpCurrent
1.3.6.1.4.1.9.9.644.1.4.9.1.9
DscpA Differentiated Services Code-Point that may be used for marking a traffic stream.Reference: RFC 2474, RFC 2780 (0..63) · Integer32 · hint d
This object specifies the DSCP marking for the current call's incoming stream.
ctpcRxDscpPrevious
1.3.6.1.4.1.9.9.644.1.4.9.1.10
DscpA Differentiated Services Code-Point that may be used for marking a traffic stream.Reference: RFC 2474, RFC 2780 (0..63) · Integer32 · hint d
This object specifies the previous DSCP marking for the current call's incoming stream.
ctpcRxCoSCurrent
1.3.6.1.4.1.9.9.644.1.4.9.1.11
QosLayer2CosAn integer that is in the range of the layer 2 CoS values. This corresponds to the 802.1p and ISL CoS values. (0..7) · Integer32
This object specifies the COS marking for the current call's incoming stream.
ctpcRxCoSPrevious
1.3.6.1.4.1.9.9.644.1.4.9.1.12
QosLayer2CosAn integer that is in the range of the layer 2 CoS values. This corresponds to the 802.1p and ISL CoS values. (0..7) · Integer32
This object specifies the previous COS marking for the current call's incoming stream.
CtpcStreamSourceType1 = secCodec12 = priCodec3 = secCodec24 = auxiliary15 = secLegacy16 = priLegacy7 = secLegacy28 = auxiliary29 = center10 = left11 = right12 = legacyCtr13 = legacyLeft14 = legacyRight15 = auxiliary316 = auxiliary417 = otherThis textual convention identifies the stream source of a call.
secCodec1 (1) -- First secondary CODEC stream
priCodec (2) -- Primary CODEC stream
secCodec2 (3) -- Second secondary CODEC stream
auxiliary1 (4) -- First auxiliary stream like presentation
stream.
secLegacy1 (5) -- Legacy stream generated by first
secondary CODEC for legacy system.
priLegacy (6) -- Legacy stream generated by Primary CODEC
for legacy system.
secLegacy2 (7) -- Legacy stream generated by second
secondary CODEC for legacy system.
auxiliary2 (8) -- Second auxiliary stream.
center (9) -- Center stream.
left (10)-- Left stream.
right (11)-- Right stream.
legacyCtr (12)-- Legacy stream center.
legacyLeft (13)-- Legacy stream left.
legacyRight (14)-- Legacy stream right.
auxiliary3 (15)-- Third auxiliary stream.
auxiliary4 (16)-- Forth auxiliary stream.
other (17)-- Not in the above list. · Integer32
This object specifies the call stream source.
ctpcTxActive
1.3.6.1.4.1.9.9.644.1.4.10.1.2
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object is set to 'true' if data transmit from a stream source is 'active'.
ctpcTxTotalBytes
1.3.6.1.4.1.9.9.644.1.4.10.1.3
Counter64 (0..18446744073709551615) · bytes
This object specifies the total number of bytes transmitted from a stream source.
ctpcTxTotalPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.4
Counter64 (0..18446744073709551615) · packets
This object specifies the total number of packets transmitted from a stream source.
ctpcTxLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.5
Counter64 (0..18446744073709551615) · packets
This object specifies the number packets failed to deliver from a stream source.
ctpcTxPeriodLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.6
Gauge32 (0..100000000) · micropercent
This object specifies the micropercent of packets failed to deliver from a stream source within the last sample period specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcTxCallLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.7
Gauge32 (0..100000000) · micropercent
This object specifies the micropercent of packets failed to deliver from a stream source for the duration of a call.
ctpcTxIDRPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.8
Counter64 (0..18446744073709551615) · packets
This object specifies the number of IDR packets transmitted from a stream source.
ctpcTxShapingWindow
1.3.6.1.4.1.9.9.644.1.4.10.1.9
Gauge32 · milliseconds
This object specifies the time span between the last video packet and first video packet of a transmitted video frame.
This object is only applicable for video stream type.
ctpcRxActive
1.3.6.1.4.1.9.9.644.1.4.10.1.10
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object is set to 'true' if data received by a stream source is 'active'.
ctpcRxTotalBytes
1.3.6.1.4.1.9.9.644.1.4.10.1.11
Counter64 (0..18446744073709551615) · bytes
This object specifies the total number of bytes received by a stream source.
ctpcRxTotalPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.12
Counter64 (0..18446744073709551615) · packets
This object specifies the total number of packets received by a stream source.
ctpcRxLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.13
Counter64 (0..18446744073709551615) · packets
This object specifies the number packets failed to reach a stream source.
ctpcRxPeriodLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.14
Gauge32 (0..100000000) · micropercent
This object specifies the micropercent of packets failed to reach a stream source within the last sample period specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcRxCallLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.15
Gauge32 (0..100000000) · micropercent
This object specifies the micropercent of packets failed to reach a stream source.
ctpcRxOutOfOrderPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.16
Counter64 (0..18446744073709551615) · packets
This object specifies the number packets received out of order by a stream source.
ctpcRxDuplicatePackets
1.3.6.1.4.1.9.9.644.1.4.10.1.17
Counter64 (0..18446744073709551615) · packets
This object specifies the number duplicated packets received by a stream source.
ctpcRxLatePackets
1.3.6.1.4.1.9.9.644.1.4.10.1.18
Counter64 (0..18446744073709551615) · packets
This object specifies the number late packets received by a stream source.
ctpcRxIDRPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.19
Counter64 (0..18446744073709551615) · packets
This object specifies the number of IDR packets received by a stream source.
ctpcRxShapingWindow
1.3.6.1.4.1.9.9.644.1.4.10.1.20
Gauge32 · milliseconds
This object specifies the time span between the last video packet and first video packet of a received video frame.
This object is only applicable for video stream type.
ctpcRxCallAuthFailure
1.3.6.1.4.1.9.9.644.1.4.10.1.21
Counter64 (0..18446744073709551615) · packets
This object specifies the number of authenticated packets for which verification failed.
ctpcAvgPeriodJitter
1.3.6.1.4.1.9.9.644.1.4.10.1.22
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64 · milliseconds
This object specifies the average jitter of a stream source for a Telepresence call from the most recent sample period specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcAvgCallJitter
1.3.6.1.4.1.9.9.644.1.4.10.1.23
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64 · milliseconds
This object specifies the average jitter of a stream source for a Telepresence call among all the sample periods specified in ctpcSamplePeriod.
ctpcMaxPeriodJitter
1.3.6.1.4.1.9.9.644.1.4.10.1.24
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64 · milliseconds
This object specifies the maximum jitter of a stream source for a Telepresence call for any sample period specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcMaxCallJitter
1.3.6.1.4.1.9.9.644.1.4.10.1.25
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64 · milliseconds
This object specifies the maximum average jitter of a stream source for a Telepresence call among all the sample periods specified in ctpcSamplePeriod.
ctpcMaxCallJitterRecTime
1.3.6.1.4.1.9.9.644.1.4.10.1.26
Unsigned32 · seconds
This object specifies the elapsed time since the call is established when the maximum jitter of a stream source is recorded.
ctpcTxCodec
1.3.6.1.4.1.9.9.644.1.4.10.1.27
CtpcCodecType1 = unknown2 = other3 = aaclc4 = aacld5 = g711A6 = g711U7 = g7228 = g72219 = g72810 = g72911 = h26312 = h26413 = aacldLatm14 = h265The textual convention identifies the codec type of a stream.
unknown (1) -- Codec type is not known.
other (2) -- Codec type is not listed.
aaclc (3) -- Advanced Audio Coding, Low Complexity.
aacld (4) -- MPEG-4 Low Delay Audio Codec.
g711A (5) -- G.711 A-Law audio codec.
g711U (6) -- G.711 U-Law audio codec.
g722 (7) -- G.722 audio codec.
g7221 (8) -- G.7221 audio codec.
g728 (9) -- G.728 audio codec.
g729 (10) -- G.729 audio codec.
h263 (11) -- H.263 video codec.
h264 (12) -- H.264 video codec.
aacldLatm (13) -- Advanced Audio Coding, Low Delay, -- Low-overhead MPEG4 Audio Transport -- Multiplexing.
h265 (14) -- H.265 video codec. · Integer32
This object specifies the transmitted media codec type of a stream source.
ctpcTxFrameRate
1.3.6.1.4.1.9.9.644.1.4.10.1.28
Unsigned32 · millifps
This object specifies the transmitted frame rate of a stream source.
ctpcRxCodec
1.3.6.1.4.1.9.9.644.1.4.10.1.29
CtpcCodecType1 = unknown2 = other3 = aaclc4 = aacld5 = g711A6 = g711U7 = g7228 = g72219 = g72810 = g72911 = h26312 = h26413 = aacldLatm14 = h265The textual convention identifies the codec type of a stream.
unknown (1) -- Codec type is not known.
other (2) -- Codec type is not listed.
aaclc (3) -- Advanced Audio Coding, Low Complexity.
aacld (4) -- MPEG-4 Low Delay Audio Codec.
g711A (5) -- G.711 A-Law audio codec.
g711U (6) -- G.711 U-Law audio codec.
g722 (7) -- G.722 audio codec.
g7221 (8) -- G.7221 audio codec.
g728 (9) -- G.728 audio codec.
g729 (10) -- G.729 audio codec.
h263 (11) -- H.263 video codec.
h264 (12) -- H.264 video codec.
aacldLatm (13) -- Advanced Audio Coding, Low Delay, -- Low-overhead MPEG4 Audio Transport -- Multiplexing.
h265 (14) -- H.265 video codec. · Integer32
This object specifies the received media codec type of a stream source.
ctpcRxFrameRate
1.3.6.1.4.1.9.9.644.1.4.10.1.30
Unsigned32 · millifps
This object specifies the received frame rate of a stream source.
ctpcTxVideoHorzPixels
1.3.6.1.4.1.9.9.644.1.4.10.1.31
Gauge32 (0..65535) · pixels
This object specifies the number of horizontal pixels in the outgoing video stream.
When a call is terminated, the value will be the last recorded number of horizontal pixels for the outgoing video stream.
ctpcTxVideoVertPixels
1.3.6.1.4.1.9.9.644.1.4.10.1.32
Gauge32 (0..65535) · pixels
This object specifies the number of vertical pixels in the outgoing video stream.
When a call is terminated, the value will be the last recorded number of vertical pixels for the outgoing video stream.
ctpcRxVideoHorzPixels
1.3.6.1.4.1.9.9.644.1.4.10.1.33
Gauge32 (0..65535) · pixels
This object specifies the number of horizontal pixels in the incoming video stream.
When a call is terminated, the value will be the last recorded number of horizontal pixels for the incoming video stream.
ctpcRxVideoVertPixels
1.3.6.1.4.1.9.9.644.1.4.10.1.34
Gauge32 (0..65535) · pixels
This object specifies the number of vertical pixels in the incoming video streams.
When a call is terminated, the value will be the last recorded number of vertical pixels for the incoming video stream.
ctpcTxCallBitRate
1.3.6.1.4.1.9.9.644.1.4.10.1.35
Gauge32 · Kbps
This object indicates the bit rate transmitted from a stream source.
ctpcTxPeriodBitRate
1.3.6.1.4.1.9.9.644.1.4.10.1.36
Gauge32 · Kbps
This object indicates the bit rate transmitted from a stream source within the last sample period that specified in ctpcSamplePeriod.
ctpcRxCallBitRate
1.3.6.1.4.1.9.9.644.1.4.10.1.37
Gauge32 · Kbps
This object indicates the bit rate received from a stream source.
ctpcRxPeriodBitRate
1.3.6.1.4.1.9.9.644.1.4.10.1.38
Gauge32 · Kbps
This object indicates the bit rate received from a stream source within the last sample period that specified in ctpcSamplePeriod.
ctpcRxMaxPeriodLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.39
Gauge32 (0..100000000) · micropercent
This object indicates the maximum micropercent of packets failed to reach a stream source within the last sample period that specified in ctpcSamplePeriod.
When a call is terminated, the value will be reset to '0'.
ctpcRxMaxCallLostPackets
1.3.6.1.4.1.9.9.644.1.4.10.1.40
Gauge32 (0..100000000) · micropercent
This object indicates the maximum micropercent of packets failed to reach a stream source for the duration of a call.
ctpcRxMaxCallLostPacketsRecTime
1.3.6.1.4.1.9.9.644.1.4.10.1.41
Gauge32 · seconds
This object indicates the elapsed time since the call is established when the maximum packet loss of a call is recorded.
ctpcStatEventHistoryTable
1.3.6.1.4.1.9.9.644.1.5.3
Index: ctpcStatEventHistoryIndex
This table contains a history of Telepresence call monitoring thresholds crossed events.
After management system initialization (i.e. when
sysUpTime is reset to zero), this table records all notifications until it reaches its capacity specified in ctpcStatEventHistTableSize. Thereafter, it remains full by retaining the most recent notifications.
ctpcStatEventHistoryIndex
1.3.6.1.4.1.9.9.644.1.5.3.1.1
Unsigned32 (1..4294967295)
A unique non-zero integer value that identifies a row in this table.
The value of this table starts from '1' and monotonically increases for each threshold crossed event received by the agent. If the value of this object is '4294967295', the agent will reset it to '1' upon receiving the next event.
ctpcStatEventMonObjectInst
1.3.6.1.4.1.9.9.644.1.5.3.1.2
VariablePointerA pointer to a specific object instance. For example, sysContact.0 or ifInOctets.3. · OBJECT IDENTIFIER
This object specifies a complete OID of a monitoring object which was crossed.
For example, the OID of ctpcAvgPeriodLatency.1.video would represent video latency of a call with call index '1' crossed the threshold set by the corresponding ctpcStatMonitoredEntry.
ctpcStatEventCrossedValue
1.3.6.1.4.1.9.9.644.1.5.3.1.3
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64
This object specifies the value of monitoring object when the threshold was crossed.
ctpcStatEventCrossedType
1.3.6.1.4.1.9.9.644.1.5.3.1.4
CtpcStatThreshCrossedType1 = risingThreshold2 = fallingThresholdThe textual convention identifies the monitoring threshold cross type.
risingThreshold (1) --
The sample data has crossed the rising threshold. fallingThreshold (2) -- The sample data has crossed the falling threshold. · Integer32
This object specifies the type of threshold which was crossed and thereby triggered this event.
ctpcStatEventTimeStamp
1.3.6.1.4.1.9.9.644.1.5.3.1.5
TimeTicks
This object specifies the value of the sysUpTime object at the time the notification was generated.
ctpcMgmtSysConnEventHistoryTable
1.3.6.1.4.1.9.9.644.1.6.3
Index: ctpcMgmtSysConnEventHistoryIndex
This table contains a history of call management system connection state changes.
After management system initialization (i.e. when
sysUpTime is reset to zero), this table records all notifications until it reaches its capacity specified in ctpcMgmtSysConnEventHistTableSize. Thereafter, it remains full by retaining the most recent notifications.
ctpcMgmtSysConnEventHistoryIndex
1.3.6.1.4.1.9.9.644.1.6.3.1.1
Unsigned32 (1..4294967295)
A unique non-zero integer value that identifies a row in this table.
The value of this table starts from '1' and monotonically increases for each management system connection event received by the agent. If the value of this object is '4294967295', the agent will reset it to '1' upon receiving the next event.
ctpcMgmtSysConnEventStatus
1.3.6.1.4.1.9.9.644.1.6.3.1.2
CtpcMgmtSysConnStatusCode1 = unknown2 = other3 = internalError4 = notRegister5 = registered6 = registraionFailureThe textual convention identifies the management system connection status.
unknown (1) --
Call management system connection status is unknown.
other (2) --
Call management system connection status is not listed.
internalError (3) --
Telepresence system has internal system error to return call management system connection status.
notRegister (4) --
Telepresence system is not register to the call management system.
registered (5) --
Telepresence registered to a call management system. registrationFailure (6) -- Call management system registration failed. · Integer32
This object specifies a call management system connection state when the event happened.
ctpcMgmtSysConnEventSIPRespCode
1.3.6.1.4.1.9.9.644.1.6.3.1.3
Unsigned32
Reference: RFC 3261, section 21
This object specifies SIP response code from call management system when the event happened.
ctpcMgmtSysConnEventTimeStamp
1.3.6.1.4.1.9.9.644.1.6.3.1.4
TimeTicks
This object specifies the value of the sysUpTime object at the time the notification was generated.
Trap details
ctpcMgmtSysConnFailNotification
1.3.6.1.4.1.9.9.644.0.1
This notification is sent when a call management system connection failure occurs.
This notification is deprecated in favor of ctpcMgmtSysConnEventNotification. ctpcMgmtSysConnFailNotification object is superseded by ctpcMgmtSysConnEventNotification.
ctpcMgmtSysAddrType
1.3.6.1.4.1.9.9.644.1.2.6.1.2
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
This object specifies the type of address contained in the corresponding instance of ctpcMgmtSysAddr.
ctpcMgmtSysAddr
1.3.6.1.4.1.9.9.644.1.2.6.1.3
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
This object specifies a call management system address which a Telepresence system can connect to if it is in 'mgmtSys' mode.
It is in the format given by the corresponding instance of ctpcMgmtSysAddrType.
ctpcStatNotificaion
1.3.6.1.4.1.9.9.644.0.2
This notification is sent when a call monitoring threshold is crossed.
ctpcStatEventMonObjectInst
1.3.6.1.4.1.9.9.644.1.5.3.1.2
VariablePointerA pointer to a specific object instance. For example, sysContact.0 or ifInOctets.3. · OBJECT IDENTIFIER
This object specifies a complete OID of a monitoring object which was crossed.
For example, the OID of ctpcAvgPeriodLatency.1.video would represent video latency of a call with call index '1' crossed the threshold set by the corresponding ctpcStatMonitoredEntry.
ctpcStatEventCrossedValue
1.3.6.1.4.1.9.9.644.1.5.3.1.3
Unsigned64An unsigned 64 bit integer. We use SYNTAX Counter64 for the encoding rules. (0..18446744073709551615) · Counter64
This object specifies the value of monitoring object when the threshold was crossed.
ctpcStatEventCrossedType
1.3.6.1.4.1.9.9.644.1.5.3.1.4
CtpcStatThreshCrossedType1 = risingThreshold2 = fallingThresholdThe textual convention identifies the monitoring threshold cross type.
risingThreshold (1) --
The sample data has crossed the rising threshold. fallingThreshold (2) -- The sample data has crossed the falling threshold. · Integer32
This object specifies the type of threshold which was crossed and thereby triggered this event.
ctpcMgmtSysConnEventNotification
1.3.6.1.4.1.9.9.644.0.3
This notification is sent when a call management system connection state change occurs.
ctpcMgmtSysAddrType
1.3.6.1.4.1.9.9.644.1.2.6.1.2
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
This object specifies the type of address contained in the corresponding instance of ctpcMgmtSysAddr.
ctpcMgmtSysAddr
1.3.6.1.4.1.9.9.644.1.2.6.1.3
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
This object specifies a call management system address which a Telepresence system can connect to if it is in 'mgmtSys' mode.
It is in the format given by the corresponding instance of ctpcMgmtSysAddrType.
ctpcMgmtSysConnStatus
1.3.6.1.4.1.9.9.644.1.2.6.1.4
CtpcMgmtSysConnStatusCode1 = unknown2 = other3 = internalError4 = notRegister5 = registered6 = registraionFailureThe textual convention identifies the management system connection status.
unknown (1) --
Call management system connection status is unknown.
other (2) --
Call management system connection status is not listed.
internalError (3) --
Telepresence system has internal system error to return call management system connection status.
notRegister (4) --
Telepresence system is not register to the call management system.
registered (5) --
Telepresence registered to a call management system. registrationFailure (6) -- Call management system registration failed. · Integer32
This object specifies the last connection state between the Telepresence and a call management system.
ctpcMgmtSysSIPRespCode
1.3.6.1.4.1.9.9.644.1.2.6.1.5
Unsigned32
Reference: RFC 3261, section 21
This object specifies the last SIP response code from call management system.