| 1 |
-- ******************************************************************* |
| 2 |
-- KAMAILIO-TC: Kamailio MIB Textual Conventions |
| 3 |
-- |
| 4 |
-- Date of Creation: March 2006 |
| 5 |
-- Mike Varley |
| 6 |
-- |
| 7 |
-- Copyright (c) The Internet Society (2006) |
| 8 |
-- Amendments (c) Soma Networks, Inc. (2006) |
| 9 |
-- |
| 10 |
-- ******************************************************************* |
| 11 |
|
| 12 |
|
| 13 |
KAMAILIO-TC DEFINITIONS ::= BEGIN |
| 14 |
|
| 15 |
IMPORTS |
| 16 |
MODULE-IDENTITY, |
| 17 |
Unsigned32 |
| 18 |
FROM SNMPv2-SMI |
| 19 |
TEXTUAL-CONVENTION |
| 20 |
FROM SNMPv2-TC |
| 21 |
kamailioModules |
| 22 |
FROM KAMAILIO-REG-MIB; |
| 23 |
|
| 24 |
|
| 25 |
kamailioTcModule MODULE-IDENTITY |
| 26 |
LAST-UPDATED "201304041200Z" |
| 27 |
ORGANIZATION "Kamailio" |
| 28 |
CONTACT-INFO |
| 29 |
"https://www.kamailio.org" |
| 30 |
DESCRIPTION |
| 31 |
"Kamailio Global Textual Conventions." |
| 32 |
::={ kamailioModules 2 } |
| 33 |
|
| 34 |
|
| 35 |
-- |
| 36 |
-- SIP type descriptions, taken from SIP-TC in drafts-ietf-sip-mib-10.txt |
| 37 |
-- |
| 38 |
|
| 39 |
KamailioSIPTransportProtocol ::= TEXTUAL-CONVENTION |
| 40 |
STATUS current |
| 41 |
DESCRIPTION |
| 42 |
"This convention is a bit map. Each bit represents a |
| 43 |
transport protocol. If a bit has value 1, then that |
| 44 |
selected transport protocol is in some way dependent |
| 45 |
on the context of the object using this convention. |
| 46 |
If a bit has value 0, then that transport protocol |
| 47 |
is not selected. Combinations of bits can be |
| 48 |
set when multiple transport protocols are selected. |
| 49 |
|
| 50 |
bit 0 : a protocol other than those defined here. |
| 51 |
bit 1 : User Datagram Protocol. |
| 52 |
bit 2 : Transmission Control Protocol. |
| 53 |
bit 3 : Stream Control Transmission Protocol. |
| 54 |
bit 4 : Transport Layer Security Protocol. |
| 55 |
bit 5 : SCTP/Transport Layer Security Protocol. |
| 56 |
bit 6 : WebSocket transport (http) |
| 57 |
bit 7 : WebSocket over HTTP/TLS (wss)" |
| 58 |
SYNTAX BITS { |
| 59 |
other(0), -- none of the following |
| 60 |
|
| 61 |
udp(1), |
| 62 |
tcp(2), |
| 63 |
sctp(3), |
| 64 |
tls(4), |
| 65 |
sctptls(5), |
| 66 |
ws(6), |
| 67 |
wss(7) |
| 68 |
} |
| 69 |
-- REFERENCE "RFC 4780, SipTCTransportProtocol" |
| 70 |
|
| 71 |
KamailioSIPEntityRole ::= TEXTUAL-CONVENTION |
| 72 |
STATUS current |
| 73 |
DESCRIPTION |
| 74 |
"This convention defines the role of a SIP entity. |
| 75 |
Examples of SIP entities are proxies, user agents, |
| 76 |
redirect servers, registrars or combinations of |
| 77 |
the above. |
| 78 |
Kamailio adds the role 'edgeproxyServer' for |
| 79 |
operation of a SIP outbound edge proxy node. |
| 80 |
Kamailio adds the role 'sipcaptureServer' for |
| 81 |
operation of a Homer SIPcapture node." |
| 82 |
SYNTAX BITS { |
| 83 |
other(0), |
| 84 |
userAgent(1), |
| 85 |
proxyServer(2), |
| 86 |
redirectServer(3), |
| 87 |
registrarServer(4), |
| 88 |
edgeproxyServer(5), |
| 89 |
sipcaptureServer(6) |
| 90 |
} |
| 91 |
|
| 92 |
|
| 93 |
KamailioSIPMethodIdentifier ::= TEXTUAL-CONVENTION |
| 94 |
STATUS current |
| 95 |
DESCRIPTION |
| 96 |
"This is an IETF Assigned Numbers Authority (IANA) |
| 97 |
assigned number that uniquely identifies a SIP |
| 98 |
method. The scope of uniqueness is the context |
| 99 |
of all defined SIP methods. |
| 100 |
|
| 101 |
Experimental support of extension methods is |
| 102 |
acceptable and expected. Extention methods are |
| 103 |
those defined in Internet-Draft documents but |
| 104 |
not yet allocated an official number by IANA. |
| 105 |
|
| 106 |
To support experimental extension methods, any |
| 107 |
object using this textual convention as syntax |
| 108 |
MAY return/accept a method identifier value other |
| 109 |
than those defined by IANA. That system MUST |
| 110 |
ensure no collisions with officially assigned |
| 111 |
method identifier values and MUST provide an |
| 112 |
identifier to method name mapping via a mechanism |
| 113 |
like sipMethodSupportedTable." |
| 114 |
SYNTAX Unsigned32 (1..4294967295) |
| 115 |
|
| 116 |
|
| 117 |
-- |
| 118 |
-- ITU X.731 state definitions. |
| 119 |
-- |
| 120 |
|
| 121 |
|
| 122 |
X731AdminState ::= TEXTUAL-CONVENTION |
| 123 |
STATUS current |
| 124 |
DESCRIPTION |
| 125 |
"Represents the various possible administrative states. |
| 126 |
|
| 127 |
A value of 'locked' means the resource is administratively |
| 128 |
prohibited from use. A value of 'shuttingDown' means that |
| 129 |
usage is administratively limited to current instances of |
| 130 |
use. A value of 'unlocked' means the resource is not |
| 131 |
administratively prohibited from use. A value of |
| 132 |
'unknown' means that this resource is unable to |
| 133 |
report administrative state." |
| 134 |
SYNTAX INTEGER { |
| 135 |
locked (0), |
| 136 |
shuttingDown (1), |
| 137 |
unlocked (2), |
| 138 |
unknown (3) |
| 139 |
} |
| 140 |
|
| 141 |
X731OperState ::= TEXTUAL-CONVENTION |
| 142 |
STATUS current |
| 143 |
DESCRIPTION |
| 144 |
"Represents the possible values of operational states. |
| 145 |
|
| 146 |
A value of 'disabled' means the resource is totally |
| 147 |
inoperable. A value of 'enabled' means the resource |
| 148 |
is partially or fully operable. A value of 'testing' |
| 149 |
means the resource is currently being tested |
| 150 |
and cannot therefore report whether it is operational |
| 151 |
or not. A value of 'unknown' means that this |
| 152 |
resource is unable to report operational state. " |
| 153 |
|
| 154 |
SYNTAX INTEGER { |
| 155 |
disabled (0), |
| 156 |
enabled (1), |
| 157 |
unknown (2) |
| 158 |
} |
| 159 |
|
| 160 |
X731UsageState ::= TEXTUAL-CONVENTION |
| 161 |
STATUS current |
| 162 |
DESCRIPTION |
| 163 |
"Represents the possible values of usage states. |
| 164 |
A value of 'idle' means the resource is servicing no |
| 165 |
users. A value of 'active' means the resource is |
| 166 |
currently in use and it has sufficient spare capacity |
| 167 |
to provide for additional users. A value of 'busy' |
| 168 |
means the resource is currently in use, but it |
| 169 |
currently has no spare capacity to provide for |
| 170 |
additional users. A value of 'unknown' means |
| 171 |
that this resource is unable to report usage state." |
| 172 |
|
| 173 |
SYNTAX INTEGER { |
| 174 |
idle (0), |
| 175 |
active (1), |
| 176 |
busy (2), |
| 177 |
unknown (3) |
| 178 |
} |
| 179 |
|
| 180 |
X731AlarmState ::= TEXTUAL-CONVENTION |
| 181 |
STATUS current |
| 182 |
DESCRIPTION |
| 183 |
"Represents whether a particular sub-system is |
| 184 |
in an alarm state, and its severity. This value |
| 185 |
is either reported as 'clear', or one of the alarm |
| 186 |
severities. An object of this type represents one |
| 187 |
alarm in the sub-system; the alarm status (below) |
| 188 |
can be looked at as a collection of AlarmStates. |
| 189 |
|
| 190 |
A value of unknown means the object cannot report |
| 191 |
its alarm state." |
| 192 |
|
| 193 |
SYNTAX INTEGER { |
| 194 |
clear(0), |
| 195 |
critical(1), |
| 196 |
major(2), |
| 197 |
minor(3), |
| 198 |
unknown(4) |
| 199 |
} |
| 200 |
|
| 201 |
X731AlarmStatus ::= TEXTUAL-CONVENTION |
| 202 |
STATUS current |
| 203 |
DESCRIPTION |
| 204 |
"Represents the possible values of alarm status. |
| 205 |
An Alarm is a persistent indication |
| 206 |
of an error condition. |
| 207 |
|
| 208 |
When no bits of this attribute are set, then no active |
| 209 |
alarms are known against this entity and it is not under |
| 210 |
repair. |
| 211 |
|
| 212 |
When the 'value of underRepair' is set, the resource is |
| 213 |
currently being repaired, which, depending on the |
| 214 |
implementation, may make the other values in this bit |
| 215 |
string not meaningful. |
| 216 |
|
| 217 |
When the value of 'critical' is set, one or more critical |
| 218 |
alarms are active against the resource. When the value |
| 219 |
of 'major' is set, one or more major alarms are active |
| 220 |
against the resource. When the value of 'minor' is set, |
| 221 |
one or more minor alarms are active against the resource. |
| 222 |
|
| 223 |
A value of 'unknown' means that this resource is |
| 224 |
unable to report alarm state." |
| 225 |
|
| 226 |
SYNTAX BITS { |
| 227 |
underRepair (0), |
| 228 |
critical(1), |
| 229 |
major(2), |
| 230 |
minor(3), |
| 231 |
alarmOutstanding(4), |
| 232 |
unknown(5) |
| 233 |
} |
| 234 |
|
| 235 |
X731ProceduralStatus ::= TEXTUAL-CONVENTION |
| 236 |
STATUS current |
| 237 |
DESCRIPTION |
| 238 |
"Represents the possible values for the procedural status. |
| 239 |
|
| 240 |
A value of initialization required means the resource |
| 241 |
requires initialization to be invoked by the manager. |
| 242 |
The operational state should be disabled. |
| 243 |
|
| 244 |
A value of not initialized means the resource requires |
| 245 |
initialization and this procedure has not been initiatated. |
| 246 |
The resource initializes itself autonomously. The operational |
| 247 |
state may be enabled or disabled. |
| 248 |
|
| 249 |
A value of initializing means the resource requires |
| 250 |
initialization and initialization procedure has started |
| 251 |
but is not yet complete. |
| 252 |
|
| 253 |
A value of reporting means the resource has completed some |
| 254 |
processing operation and is notifying the results of the |
| 255 |
operation, e.g. a test process is sending its results. The |
| 256 |
operational state should be enabled. |
| 257 |
|
| 258 |
A value of terminating means the resource is in a termination |
| 259 |
phase." |
| 260 |
|
| 261 |
SYNTAX BITS { |
| 262 |
initializationRequired(0), |
| 263 |
notInitialized(1), |
| 264 |
initializing(2), |
| 265 |
reporting(3), |
| 266 |
terminating(4), |
| 267 |
unknown(5) |
| 268 |
} |
| 269 |
|
| 270 |
X731AvailabilityStatus ::= TEXTUAL-CONVENTION |
| 271 |
STATUS current |
| 272 |
DESCRIPTION |
| 273 |
"Represents the possible values of availability status. |
| 274 |
|
| 275 |
A value of in test means the resource is undergoing |
| 276 |
a test procedure. |
| 277 |
|
| 278 |
A value of failed means the resource has an internal |
| 279 |
fault that prevents if from operating. The operational |
| 280 |
state should be disabled. |
| 281 |
|
| 282 |
A value of power off means the resource requires power |
| 283 |
to be applied and is not powered on. The operational |
| 284 |
state should be disabled. |
| 285 |
|
| 286 |
A value of off line means the resource requires a |
| 287 |
routine operation to be performed to place it online |
| 288 |
and make it available for use. The operation may |
| 289 |
be manual or automatic or both. The operational |
| 290 |
state should be disabled. |
| 291 |
|
| 292 |
A value of off duty means the resource has been made inactive |
| 293 |
by an internal control process that is expect to reactivate |
| 294 |
the resource at some scheduled time. |
| 295 |
|
| 296 |
A value of dependency mens the resource cannot operate because |
| 297 |
some other resource on which it depends is unavailable. The |
| 298 |
operational state should be disabled. |
| 299 |
|
| 300 |
A value of degraded means the resource is providing a |
| 301 |
service that is degraded in some respect. The operational |
| 302 |
state should be enabled. |
| 303 |
|
| 304 |
A value of not installed means the resource is not present or |
| 305 |
is incomplete. The operational state should be disabled. |
| 306 |
|
| 307 |
A value of log full indicates that a log full condition |
| 308 |
exists." |
| 309 |
|
| 310 |
SYNTAX BITS { |
| 311 |
inTest(0), |
| 312 |
failed(1), |
| 313 |
powerOff(2), |
| 314 |
offLine(3), |
| 315 |
offDuty(4), |
| 316 |
dependency(5), |
| 317 |
degraded(6), |
| 318 |
notInstalled(7), |
| 319 |
logFull(8), |
| 320 |
unknown(9) |
| 321 |
} |
| 322 |
|
| 323 |
X731ControlStatus ::= TEXTUAL-CONVENTION |
| 324 |
STATUS current |
| 325 |
DESCRIPTION |
| 326 |
"Represents the possible values of control status. |
| 327 |
|
| 328 |
A value of subject to test means the resource is |
| 329 |
available to normal users but tests may be conducted |
| 330 |
on it simultaneously. |
| 331 |
|
| 332 |
A value of part of services locked means the resource is |
| 333 |
in a state where a manager has administratively restricted |
| 334 |
a part of the service from the user(s) of a resource. The |
| 335 |
administrative state should be unlocked. |
| 336 |
|
| 337 |
A value of reserved for test means the resource has been |
| 338 |
made administratively unavailable since it is undergoing |
| 339 |
a test procedure. The administrative state should be locked. |
| 340 |
|
| 341 |
A value of suspended means the resource has had its service |
| 342 |
administratively suspended. The administrative state should be |
| 343 |
unlocked." |
| 344 |
|
| 345 |
SYNTAX BITS { |
| 346 |
subjectToTest(0), |
| 347 |
partOfServicesLocked(1), |
| 348 |
reservedForTest(2), |
| 349 |
suspended(3), |
| 350 |
unknown(4) |
| 351 |
} |
| 352 |
|
| 353 |
X731StandbyStatus ::= TEXTUAL-CONVENTION |
| 354 |
STATUS current |
| 355 |
DESCRIPTION |
| 356 |
"Represents the possible values of standby status. |
| 357 |
|
| 358 |
A value of 'hotStandby' means the resource is not |
| 359 |
providing service, but it will be immediately able to |
| 360 |
take over the role of the resource to be backed-up, |
| 361 |
without the need for initialization activity, and will |
| 362 |
contain the same information as the resource to be |
| 363 |
backed up. A value of 'coldStandy' means that the |
| 364 |
resource is to back-up another resource, but will not |
| 365 |
be immediately able to take over the role of a resource |
| 366 |
to be backed up, and will require some initialization |
| 367 |
activity. A value of 'providingService' means the |
| 368 |
resource is providing service. A value of |
| 369 |
'unknown' means that this resource is unable to |
| 370 |
report standby state." |
| 371 |
|
| 372 |
SYNTAX INTEGER { |
| 373 |
hotStandby(0), |
| 374 |
coldStandby(1), |
| 375 |
providingService(2), |
| 376 |
unknown(3) |
| 377 |
} |
| 378 |
|
| 379 |
|
| 380 |
|
| 381 |
END |