Resumo
O KQueryServer é um serviço que permite obter dados referentes à configuração e estado atual de dispositivos e da API K3L.
Isso é feito através de requisições em um formato baseado no SNMP, podendo ser usado através de MIB (Management Information Base) e/ou OID (Object IDentification). A MIB é a base de informações de gerenciamento e um OID é o identificador único dentro da MIB. Para isso é necessário estabelecer uma conexão com o serviço através de uma conexão UDP, na porta 14161, utilizando o comunidade "khomp", nessa conexão transitam as requisições e suas respectivas respostas.
As respostas serão sempre codificadas como sequências de caracteres, representando valores numéricos e índices, ou nomes e identificação de recursos, dependendo da requisição. Quando a requisição for SNMP legada a resposta será um índice de um valor enumerado podendo ser verificado na página EBS.
A partir da versão 3.3 da API, a interface SNMP foi reformulada para possibilitar sua formalização na forma da RFC 1213 (Management Information Base - MIB-II). O arquivo "KHOMP-MIB" é disponibilizado junto com pacote da API e está localizado no seguinte caminho:
Windows:
c:\ProgramData\Khomp\
Linux:
/etc/khomp/
NOTA: A interface legada SNMP permanece sendo suportada para todas as queries definidas até esta versão. Queries implementadas após esta versão poderão ser suportadas somente no modo formalizado.
|
Formato de requisições
As requisições estão apresentadas como Query (Modo Compatibilidade) | SNMP legada | MIB, ou seja, o primeiro formato apresentado serão os mnemônicos e, no centro, o formato correspondente para o SNMP legada e por fim à direita o formato recomendado pela Khomp, que utiliza o formato MIB, prefixado por KHOMP-MIB::
NOTA: Algumas requisições não estão disponíveis em todos os formatos.
|
Exemplos
MIB
Na requisição abaixo é utilizado o formato MIB, prefixado por KHOMP-MIB::
, no qual requisita ao servidor a quantidade de dispositivos configurados.
Exemplo 1:
snmpget -v1 -c khomp <IP_SERVIDOR>:14161 -m +KHOMP-MIB -M +/etc/khomp KHOMP-MIB::k3lDeviceCount.0
Resposta: KHOMP-MIB::k3lDeviceCount.0 = Gauge32: 7
onde:
- 'khomp' representa a comunidade (ao invés de 'public'),
- '<IP_SERVIDOR>' indica em qual máquina o KQueryServer está rodando,
- '14161' é a porta aonde o KQueryServer por padrão esperará requisições SNMP.
- 'KHOMP-MIB::' é o prefixo que representa a Khomp na IANA (Internet Assigned Numbers Authority) assim como o prefixo
.1.3.6.1.4.1.32624
Abaixo requisita ao servidor qual é o tipo do dispositivo, nesse exemplo é preciso informar o número do serial do dispositivo.
Exemplo 2:
snmpget -v1 -c khomp <IP_SERVIDOR>:14161 -m +KHOMP-MIB -M +/etc/khomp KHOMP-MIB::k3lDeviceType.49845
Resposta: KHOMP-MIB::k3lDeviceType.49845 = INTEGER: kdtEBSE1(18)
SNMP legada
Nesse exemplo verifique que foi utilizado o formato SNMP legada, prefixado por .1.3.6.1.4.1.32624.
, na qual também requisita ao servidor a quantidade de dispositivos configurados.
Exemplo 1:
snmpget -v1 -c khomp <IP_SERVIDOR>:14161 .1.3.6.1.4.1.32624.1.1.0
Resposta: iso.3.6.1.4.1.32624.1.1.0 = STRING: "7"
Abaixo requisita ao servidor qual é o tipo do dispositivo, nesse exemplo é preciso informar o número do serial do dispositivo.
Exemplo 2:
snmpget -v1 -c khomp <IP_SERVIDOR>:14161 .1.3.6.1.4.1.32624.1.2.49845.0
Resposta: iso.3.6.1.4.1.32624.1.2.49845.0 = STRING: "18"
O retorno da requisição pode ser verificado no seguinte link: Códigos de Descrição e Estado da K3L.
ATENÇÃO: Os parâmetros 'Link' e 'Canal' começam a contagem a partir de 1 (um) nas requisições SNMP legadas. Nas requisições que utilizam a MIB como referência, a contagem começa em 0 (zero), sendo 0 tambem mapeado para o primeiro canal.
|
ATENÇÃO: Uma requisição SNMP legada deve ser iniciada por 1.3.6.1.4.1.32624. seguido pelas sequências numéricas apresentadas a seguir ou KHOMP-MIB::legacy. , sendo necessário remover o primeiro dígito da sequencia numérica.
|
Requisições Disponíveis
Informações de operação do sistema
Quantidade de dispositivos configurados
- Tipos de requisições:
- MIB: KHOMP-MIB::k3lDeviceCount.0
- QUERY: k3l.DeviceCount
- SNMP Legado: 1.1.0
- Parâmetros: Nenhum
- Retorno: int
Versão da API
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lVersionString.0
- QUERY: k3l.Config.Api.StrVersion
- SNMP Legado: 1.3.5.7.0
- Parâmetros: Nenhum
- Retorno: string
País do padrão de troca de MFC utilizado pelo R2
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lConfigurationR2Country.0
- QUERY: k3l.Config.Api.R2Country
- SNMP Legado: 1.3.5.8.0
- Parâmetros: Nenhum
- Retorno: int (KR2Country)
Quantidade total de canais no sistema
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCount
- Retorno: int
Quantidade total de canais habilitados
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountEnabled
- Retorno: int
Quantidade total de canais livres
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountIdle
- Retorno: int
Quantidade total de canais ocupados
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountBusy
- Retorno: int
Quantidade total de canais em falha
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountFail
- Retorno: int
Dispositivo
Tipo do dispositivo
- Tipos de requisições:
- MIB: KHOMP-MIB::k3lDeviceType.X
- Query: k3l.DeviceType.X
- SNMP Legado: 1.2.X.0
- Parâmetros: X = Serial
- Retorno: int (KDeviceType)
Modelo do dispositivo
- Tipo de requisição:
- QUERY: k3l.Config.Device.X.DeviceModel
- SNMP Legado: 1.3.1.X.7.0
- MIB: KHOMP-MIB::k3lDeviceModel.X
- Parâmetros: X = Serial
- Retorno: int (K*DeviceModel)
Número Serial do dispositivo
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceSerial.X
- QUERY: k3l.Config.Device.X.SerialNumber
- SNMP Legado: 1.3.1.X.16.0
- Parâmetros: X = ID na K3L
- Retorno: int
- Observação: a MIB não suporta snmpget com X = ID. Deve-se usar snmpgetnext com X=serial ou snmpwalk para essa query
Quantidade de Links do dispositivo
- Tipos de requisições:
- MIB: KHOMP-MIB::k3lDeviceLinkCount.X
- Query: k3l.Config.Device.X.LinkCount
- SNMP Legado: 1.3.1.X.1.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais do dispositivo
- Tipos de requisições:
- MIB: KHOMP-MIB::k3lDeviceChannelCount.X
- Query: k3l.Config.Device.X.ChannelCount
- SNMP Legado: 1.3.1.X.2.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais habilitados no dispositivo
- Tipos de requisições:
- MIB: KHOMP-MIB::k3lDeviceChannelCountEnabled.X
- Query: k3l.Config.Device.X.EnabledChannelCount
- SNMP: 1.3.1.X.3.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais VoIP do dispositivo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceSipChannelCount.X
- QUERY: k3l.Config.Device.X.VoIPChannelCount
- SNMP Legado: 1.3.1.X.12.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais livres
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCountIdle.X
- QUERY: k3l.Status.Channel.X.TotalIdle
- SNMP Legado: 1.4.2.X.6.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais ocupados
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCountBusy.X
- QUERY: k3l.Status.Channel.X.TotalCall
- SNMP Legado: 1.4.2.X.7.0
- Parâmetros: X = Serial
- Retorno: int
Quantidade de canais em falha
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCountFail.X
- QUERY: k3l.Status.Channel.X.TotalFail
- SNMP Legado: 1.4.2.X.5.0
- Parâmetros: X = Serial
- Retorno: int
Endereço IP do EBS
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceEbsIP.X
- QUERY: k3l.Config.EBS.X.IP
- SNMP Legado: 1.3.6.X.3.0
- Parâmetros: X = Serial
- Retorno: string
Estado de operação do dispositivo
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceOperStatus.X
- QUERY: k3l.Status.Connected.X
- SNMP Legado: 1.4.6.X.0
- Parâmetros: X = Serial
- Retorno: bool
- Observação: Estado (1=conectado, 0=desconectado)
EBS Modular
Nome do EBS Modular
Este recurso está disponível a partir da versão: 3.1.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceDescr.X
- QUERY: k3l.Config.EBS.X.String
- SNMP Legado: 1.3.6.X.1.0
- Parâmetros: X = Serial
- Retorno: string
Quantidade de grupos no dispositivo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Índice do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupIndex.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Tipo do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupType.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Índice do primeiro canal do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupFirstChannel.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Quantidade de canais do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Quantidade de canais disponíveis do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelIdle.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Quantidade de canais em falha do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelFail.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Quantidade de canais ocupados do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelBusy.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
Números dos canais GSM presentes no EBS Modular
Este recurso está disponível a partir da versão: 3.1.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelCount.X
- QUERY: k3l.Config.EBS.X.GSMChannels
- SNMP Legado: 1.3.6.X.2.0
- Parâmetros: X = Serial
- Retorno: int,int,...,int
Link
Sinalização do link
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkSignaling.X.Y
- QUERY: k3l.Config.Link.X.Y.Signaling
- SNMP Legado: 1.3.2.X.Y.1.0
- Parâmetros: X = Serial, Y = Link
- Retorno: int (KSignaling)
Nome atribuído ao link na configuração
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkDescr.X.Y
- QUERY: k3l.Config.Link.X.Y.Name
- SNMP Legado: 1.3.2.X.Y.7.0
- Parâmetros: X = Serial, Y = Link
- Retorno: string
Retorna 'E1' ou 'T1' para indicar o modo de operação do link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkOperatingMode.X.Y
- QUERY: k3l.Config.Link.X.Y.OperatingMode
- SNMP Legado: 1.3.2.X.Y.8.0
- Parâmetros: X = Serial, Y = Link
- Retorno: string
Indica se o link está recebendo a sincronização
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkReceivingClock.X.Y
- QUERY: k3l.Config.Link.X.Y.ReceivingClock
- SNMP Legado: 1.3.2.X.Y.9.0
- Parâmetros: X = Serial, Y = Link
- Retorno: bool
Quantidade de canais do link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCount.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de canais habilitados no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountEnabled.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de canais livres no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountIdle.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de canais ocupados no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de canais com falha no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountFail.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Contadores de erros do link
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkErrorCount*.X.Y
- QUERY: k3l.Status.LinkErrorCounter.X.Y
- SNMP Legado: 1.4.4.X.Y.0
- Parâmetros: X = Serial, Y = Link
- Retorno: int[16] (KLinkErrorCounter)
- Observação: A KHOMP-MIB fornece um OID para cada contador de erro. Os seguintes OIDs estão disponíveis: k3lDeviceLinkErrorCountChangesToLock, k3lDeviceLinkErrorCountLostOfSignal, k3lDeviceLinkErrorCountAlarmNotification, k3lDeviceLinkErrorCountLostOfFrame, k3lDeviceLinkErrorCountLostOfMultiframe, k3lDeviceLinkErrorCountRemoteAlarm, k3lDeviceLinkErrorCountSlipAlarm, k3lDeviceLinkErrorCountPRBS, k3lDeviceLinkErrorCountWrongEBits, k3lDeviceLinkErrorCountJitterVariation, k3lDeviceLinkErrorCountFramesWithoutSync, k3lDeviceLinkErrorCountMultiframeSignal, k3lDeviceLinkErrorCountFrameError, k3lDeviceLinkErrorCountBipolarViolation, k3lDeviceLinkErrorCountCRC4.
Estado simplificado do link (UP,DOWN)
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkOperStatus.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: bool
Estado de alarme do link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkAlarm.X.Y
- QUERY: k3l.Status.Link.X.Y.Z.E1
- SNMP Legado: 1.4.1.X.Y.Z.1.0
- Parâmetros: X = Serial, Y = Link, Z = Ignorado
- Retorno: int (KE1Status)
Retorna, separadamente, o estado simplificado (UP,DOWN) dos Rx de um link de gravação passiva.
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceHILinkOperStatus.X.Y
- Parâmetros: X = Serial, Y = Rx do link
- Retorno: bool
- Observação: No caso de uma E1HI 300 ou para o Link 0 de uma E1HI 600, passando '0' como parâmetro acessa-se o primeiro Rx e com '1', o segundo Rx. Para o Link 1 de uma E1HI 600, passa-se como parâmetro '2' para acessar o primeiro Rx e '3' para o segundo Rx.
Retorna, separadamente, o estado dos Rx de um link de gravação passiva
Este recurso está disponível a partir da versão: 3.1.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceHILinkAlarm.X.Y
- QUERY: k3l.Status.Link.X.Y.HI
- SNMP Legado: 1.4.1.X.Y.3.0
- Parâmetros: X = Serial, Y = Rx do link
- Retorno: int (KE1Status)
- Observação: No caso de uma E1HI 300 ou para o Link 0 de uma E1HI 600, passando '0' como parâmetro acessa-se o primeiro Rx e com '1', o segundo Rx. Para o Link 1 de uma E1HI 600, passa-se como parâmetro '2' para acessar o primeiro Rx e '3' para o segundo Rx.
Canal
Sinalização do canal
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelSignaling.X.Y
- QUERY: k3l.Config.Channel.X.Y.Signaling
- SNMP Legado: 1.3.3.X.Y.1.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KSignaling)
Estado do canal
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceE1ChannelStatus.X.Z
- QUERY: k3l.Status.Link.X.Y.Z.Channels
- SNMP Legado: 1.4.1.X.Y.Z.2.0
- Parâmetros: X = Serial, Y = Link, Z = Canal
- Retorno: int (KE1ChannelStatus)
Estado extendido por sinalização
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDevice*ChannelStatus.X.Y
- QUERY: k3l.Status.Channel.X.Y.AddInfo
- SNMP Legado: 1.4.2.X.Y.3.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (K*ChannelStatus)
- Observação: A KHOMP-MIB fornece um OID de estado de canal para cada tipo de canal. Os OIDs disponíveis são: k3lDeviceE1ChannelStatus, k3lDeviceFxoChannelStatus, k3lDeviceFxsChannelStatus, k3lDeviceGsmChannelStatus, k3lDeviceSipChannelStatus.
Estado do áudio no canal
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelAudioStatus.X.Y
- QUERY: k3l.Status.Channel.X.Y.AudioStatus
- SNMP Legado: 1.4.2.X.Y.2.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KDetectionTone)
Recursos habilitados
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelEnabledFeatures.X.Y
- QUERY: k3l.Status.Channel.X.Y.EnabledFeatures
- SNMP Legado: 1.4.2.X.Y.4.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KChannelFeatures)
Indica se o canal está gravando
Este recurso está disponível a partir da versão: 3.2.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelRecording.X.Y
- QUERY: k3l.Status.Channel.X.Y.RecordingStatus
- SNMP Legado: 1.4.2.X.10.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: bool
Indica se o canal está com uma cadência ativa
Este recurso está disponível a partir da versão: 3.5.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCadenceStatus.X.Y
- QUERY: k3l.Status.Channel.X.Y.CadenceStatus
- SNMP Legado: 1.4.2.X.Y.13.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: bool
Chamada
Estado da chamada
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCallStatus.X.Y
- QUERY: k3l.Status.Channel.X.Y.CallStatus
- SNMP Legado: 1.4.2.X.Y.1.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KCallStatus)
Número discado na ligação corrente
Este recurso está disponível a partir da versão: 3.2.
|
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.Y.DestinationAddress
- SNMP Legado: 1.4.2.X.Y.8.0
- MIB: KHOMP-MIB::k3lDeviceChannelDestinationAddress.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
- Observação: k3l.Status.Channel.X.Y.DialNumber também é uma query válida
Número de origem na ligação corrente
Este recurso está disponível a partir da versão: 3.3.1.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelOriginAddress.X.Y
- QUERY: k3l.Status.Channel.X.Y.OriginAddress
- SNMP Legado: 1.4.2.X.Y.12.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
Duração da ligação corrente em milissegundos
Este recurso está disponível a partir da versão: 3.2.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelCallDuration.X.Y
- QUERY: k3l.Status.Channel.X.Y.CallDuration
- SNMP Legado: 1.4.2.X.Y.9.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
Estatisticas de Chamadas
Dispositivo
Quantidade de chamadas entrantes
- Tipo de requisição:
- SNMP: KHOMP-MIB::k3lDeviceStatsIncoming.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de chamadas saintes
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceStatsOutgoing.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de chamadas saintes completadas
- Tipo de requisição:
- SNMP: KHOMP-MIB::k3lDeviceOutgoingCompleted.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas saintes
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceOutgoingError.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de chamadas que sofreram desconexão remota
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceRemoteDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros que sofreram desconexão local
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLocalDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas ocupadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailBusy.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas sem resposta
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailNoAnswer.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas rejeitadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailRejected.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas cujo numero de destino mudou
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailChangedNumber.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas de numero invalido
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailInvalidNumber.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas fora de serviço
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailOutOfService.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros devido a congestionamento na linha
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailCongestion.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros devido a falha na rede
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailNetworkFailure.X
- Parâmetros: X = Serial
- Retorno: int
Quantidade de erros em chamadas (outros)
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailOther.X
- Parâmetros: X = Serial
- Retorno: int
Link
Quantidade de chamadas entrantes no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkStatsIncoming.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de chamadas saintes no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkStatsOutgoing.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de chamadas saintes completadas no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkOutgoingCompleted.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas saintes no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkOutgoingError.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de chamadas no link que sofreram desconexão remota
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkRemoteDisconnect.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros no link que sofreram desconexão local
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkLocalDisconnect.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas ocupadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas sem resposta
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailNoAnswer.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas rejeitadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailRejected.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas cujo numero de destino mudou
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailChangedNumber.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas de numero invalido
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailInvalidNumber.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas fora de serviço
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailOutOfService.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros devido a congestionamento na linha
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailCongestion.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros devido a falha na rede
- Tipo de requisição:
- MIB: HOMP-MIB::k3lDeviceLinkCallFailNetworkFailure.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Quantidade de erros em chamadas (outros)
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailOther.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
Canal
Média da duração das ligações do canal, em segundos
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelAverageCallTime.X.Y
- QUERY: k3l.Status.Channel.X.Y.AverageCallTime
- SNMP Legado: 1.4.2.X.Y.11.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
Contadores separados por canal
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelStats*.X.Y
- QUERY: k3l.ChannelStats.X.Y
- SNMP Legado: 1.5.X.Y.0
- Parâmetros: X = Serial, Y = Canal
- Retorno: int[16] (KGeneralCallStatIndex, KFailedCallStatIndex)
- Observação: A KHOMP-MIB fornece um OID para cada contador. Os seguintes OIDs estão disponíveis: k3lDeviceChannelStatsIncoming, k3lDeviceChannelStatsOutgoing, k3lDeviceChannelStatsOutgoingCompleted, k3lDeviceChannelStatsOutgoingError, k3lDeviceChannelStatsRemoteDisconnect, k3lDeviceChannelStatsLocalDisconnect, k3lDeviceChannelStatsCallFailBusy, k3lDeviceChannelStatsCallFailNoAnswer, k3lDeviceChannelStatsCallFailRejected, k3lDeviceChannelStatsCallFailChangedNumber, k3lDeviceChannelStatsCallFailInvalidNumber, k3lDeviceChannelStatsCallFailOutOfService, k3lDeviceChannelStatsCallFailCongestion, k3lDeviceChannelStatsCallFailNetworkFailure, k3lDeviceChannelStatsCallFailOther.
GSM
Nível de sinal
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelSignalStrength.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.SignalStrength.Z
- SNMP Legado: 1.4.5.X.Y.1.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int [0 - 100]
- Retorno: 255 SIM CARD não registrado
Taxa de erros
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelErrorRate.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.ErrorRate.Z
- SNMP Legado: 1.4.5.X.Y.2.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int [0 - 7] (0 = sem erros, 7 = altíssima taxa de erros)
Estado do registro
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelRegistryStatus.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.RegistryStatus.Z
- SNMP Legado: 1.4.5.X.Y.3.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int (KGsmRegistryStatus)
Nome da operadora
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelOperName.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.OperName.Z
- SNMP Legado: 1.4.5.X.Y.4.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
Número de SMS não lidos
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelUnreadSmsMessages.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.UnreadSmsCount.Z
- SNMP Legado: 1.4.5.X.Y.5.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
Recursos habilitados
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelEnabledFeatures.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.EnabledFeatures.Z
- SNMP Legado: 1.4.5.X.Y.6.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
Retorna o número IMEI
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelImei.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.IMEI.Z
- SNMP Legado: 1.4.5.X.Y.7.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Observação: IMEI (International Mobile Equipment Identity / Identificação Internacional de Equipamento Móvel)
SIM card atualmente selecionado
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelSim.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.SIM.Z
- SNMP Legado: 1.4.5.X.Y.8.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: char
Estado da chamada Z no canal Y
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmCallStatus.X.Y.Z
- QUERY: k3l.Status.GSMChannel.X.Y.CallStatus.Z
- SNMP Legado: 1.4.5.X.Y.9.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Chamada
- Retorno: int,int,string,int (K3L_GSM_CALL_STATUS)
Retorna o número IMSI
Este recurso está disponível a partir da versão: 3.2.4.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelImsi.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.IMSI.Z
- SNMP Legado: 1.4.5.X.Y.10.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Observação: IMSI (International Mobile Subscriber Identity)
Retorna o número ICCID
Este recurso está disponível a partir da versão: 3.2.4.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelIccid.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.ICCID.Z
- SNMP Legado: 1.4.5.X.Y.11.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Observação: ICCID (Integrated Circuit Card ID)
Retorna o número MSISDN
Este recurso está disponível a partir da versão: 3.3.1.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelMsisdn.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.MSISDN.Z
- SNMP Legado: 1.4.5.X.Y.12.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Observação: MSISDN (Mobile Systems ISDN Number)
Retorna o estado do recurso de Call Waiting
Este recurso está disponível a partir da versão: 3.3.3.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelCallWaiting.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.CallWaiting.Z
- SNMP Legado: 1.4.5.X.Y.13.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Observação: Call Waiting (0=disabled 1=enabled 2=unknown)
Retorna o numeo de SIM cards no modem
Este recurso está disponível a partir da versão: 3.3.7.
|
- Tipos de requisição:
- MIB: KHOMP-MIB::k3lDeviceGsmChannelSimCardCount.X.Y
- QUERY: k3l.Status.GSMChannel.X.Y.SimCardCount.Z
- SNMP Legado: 1.4.5.X.Y.14.Z.0
- Parâmetros: X = Serial, Y = Canal, Z = ignorado
- Retorno: int
VoIP
SIP
Perfil
Endereço local utilizado para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.LocalAddress
- MIB: KHOMP-MIB::k3lDeviceVoipProfileLocalAddress.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Porta local utilizada para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.LocalPort
- MIB: KHOMP-MIB::k3lDeviceVoipProfileLocalPort.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: int
Tipo de transporte (UDP ou TCP) utilizado para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.TransportType
- MIB: KHOMP-MIB::k3lDeviceVoipProfileTransportType.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Endereço local utilizado para a troca de áudio RTP
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.RTPAddress
- MIB: KHOMP-MIB::k3lDeviceVoipProfileRTPAddress.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
"Address of Record" utilizado no registro
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.User
- MIB: KHOMP-MIB::k3lDeviceVoipProfileUser.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Parâmetro "username" utilizado no campo "Authorization".
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.AuthorizationUser
- MIB: KHOMP-MIB::k3lDeviceVoipProfileAuthorizationUser.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Parâmetro "realm" utilizado no campo "Authorization"
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.Realm
- MIB: KHOMP-MIB::k3lDeviceVoipProfileRealm.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Endereço do servidor onde será feito o registro.
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.Domain
- MIB: KHOMP-MIB::k3lDeviceVoipProfileDomain.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Porta do servidor onde será feito o registro
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.DomainPort
- MIB: KHOMP-MIB::k3lDeviceVoipProfileDomainPort.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: int
Endereço do proxy por onde a mensagem deve passar antes de chegar no servidor
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.Proxy
- MIB: KHOMP-MIB::k3lDeviceVoipProfileProxy.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Porta do proxy por onde a mensagem deve passar antes de chegar no servidor
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.ProxyPort
- MIB: KHOMP-MIB::k3lDeviceVoipProfileProxyPort.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: int
Indica se o profile está registrado ou não em um servidor
- Tipo de requisição:
- QUERY: voip.GW.Profile.X.Registered
- MIB: KHOMP-MIB::k3lDeviceVoipProfileRegistered.X
- Parâmetros: X = SIP Profile id, retornado por
EV_SIP_REGISTER_INFO
- Retorno: string
Canal
Número de transações.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.TransactionCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelTransactionCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
- Observação: Cliente e servidora.
Número de transações cliente.
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelClientTransactionCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações servidora.
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelServerTransactionCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações cliente com falha
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailureCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelClientTransactionFailureCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações servidora com falha
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailureCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelServerTransactionFailureCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações cliente com falha (código de erro 4xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure4xxCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelClientTransactionFailure4xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações servidora com falha (código de erro 4xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure4xxCount
- MIB: KHOMP-MIB:: k3lDeviceVoipChannelServerTransactionFailure4xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações cliente com falha (código de erro 5xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure5xxCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelClientTransactionFailure5xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações servidora com falha (código de erro 5xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure5xxCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelServerTransactionFailure5xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações cliente com falha (código de erro 6xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure6xxCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelClientTransactionFailure6xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de transações servidora com falha (código de erro 6xx)
Este recurso está disponível a partir da versão: 3.3.6.
|
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure6xxCount
- MIB: KHOMP-MIB::k3lDeviceVoipChannelServerTransactionFailure6xxCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
RTP
Número de sequência do último pacote RTP enviado
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.LastSequenceNumber
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusTransmitLastSequenceNumber.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de pacotes RTP enviados
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.PacketCount
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusTransmitPacketCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número total de octetos RTP enviados
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.OctetCount
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusTransmitOctetCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de pacotes RTP enviados perdidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.PacketLost
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusTransmitPacketLost.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de sequência do primeiro pacote RTP recebido
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.InitialSequenceNumber
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusReceiveInitialSequenceNumber.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de sequência do último pacote RTP recebido
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.LastSequenceNumber
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusReceiveLastSequenceNumber.X
- Parâmetros: X = Canal SIP
- Retorno: int
Número de pacotes RTP recebidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.PacketCount
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusReceivePacketCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Quantidade total de pacotes entrantes perdidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.DroppedCount
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusReceiveDroppedCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
Quantidade de pacotes entrantes perdidos em sequência
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.LastDroppedCount
- MIB: KHOMP-MIB::k3lDeviceVoipRTPStatusReceiveLastDroppedCount.X
- Parâmetros: X = Canal SIP
- Retorno: int
- Observação: Ao receber um pacote com o número de sequência esperado, este contador é zerado.
SS7
ISUP
Retorna uma lista com os nomes dos grupos de circuitos presentes no arquivo de configuração
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup
- Parâmetros: Nenhum
- Retorno: string
Retorna o point code de origem (originating point code)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.opc
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
Retorna o point code de destino (destination point code)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.dpc
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
Retorna o código de identificação do circuito (circuit identification code) inicial
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.baseCIC
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
Indica se representa um grupo de sinalização passiva
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.passive
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
Retorna o número de circuitos
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.circuitCount
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
Retorna o mapa de timeslot
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.timeslotMap
- Parâmetros: X = Nome do grupo de circuito
- Retorno: hex
Retorna o endereço IP onde está localizado o grupo de circuito
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.address
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
Retorna o número de série da placa, localizada na máquina informada pelo campo address
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.device
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
Retorna o número do link, localizado na máquina e placa informadas pelos campos address e device
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.link
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
Indica se o call control do grupo está ativo
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.CCActivated
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
- Observação: Caso o grupo esteja localizado na própria máquina servidora, sempre estará ativo. Caso esteja em uma máquina cliente, retornará true quando o mesmo estiver conectado ao servidor (através do K3L-Remote).
Indica se o link da placa está ativo (informado pelo HDLC)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.LinkActivated
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
Indica se algum link mtp3 está ativo para o grupo de circuito (informado pelo MTP3)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.MTPResumed
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
Retorna o valor do timer resume (em milissegundos)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.TResume
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Observação: Este timer é utilizado para consultar o status do grupo de circuito adjacente após a indicação de que o link mtp3 está ativo.
Retorna o valor do timer pause (em milissegundos)
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.TPause
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Observação: Este timer é utilizado para bloquear os canais do call control após a indicação de que o link mtp3 está desativo.
Retorna uma lista com os valores dos códigos de identificação do circuito do grupo do circuito
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
Retorna o valor do identificador global único do circuito
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.cid
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
Retorna o status presente na máquina de estados do SS7 do circuito
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.callStatus
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: string
- Observação: O status pode apresentar as seguintes informações: Free, Incoming call, Outgoing call, Incoming lock e Outgoing lock.
Retorna o valor do timer T1
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T1
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T1 (em milissegundos).
Retorna o valor do timer T5
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T5
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T5 (em milissegundos).
Retorna o valor do timer T6
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T6
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T6 (em milissegundos).
Retorna o valor do timer T7
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T7
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T7 (em milissegundos).
Retorna o valor do timer T8
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T8
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T8 (em milissegundos).
Retorna o valor do timer T9
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T9
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T9 (em milissegundos).
Retorna o valor do timer T12
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T12
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T12 (em milissegundos).
Retorna o valor do timer T13
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T13
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T13 (em milissegundos).
Retorna o valor do timer T14
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T14
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T14 (em milissegundos).
Retorna o valor do timer T15
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T15
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T15 (em milissegundos).
Retorna o valor do timer T16
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T16
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T16 (em milissegundos).
Retorna o valor do timer T17
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T17
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T17 (em milissegundos).
Retorna o valor do timer T18
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T18
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T18 (em milissegundos).
Retorna o valor do timer T19
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T19
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T19 (em milissegundos).
Retorna o valor do timer T20
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T20
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T20 (em milissegundos).
Retorna o valor do timer T21
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T21
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T21 (em milissegundos).
Retorna o valor do timer T22
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T22
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T22 (em milissegundos).
Retorna o valor do timer T23
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T23
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T23 (em milissegundos).
Retorna o valor do timer T24
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T24
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T24 (em milissegundos).
Retorna o valor do timer T25
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T25
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T25 (em milissegundos).
Retorna o valor do timer T26
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T26
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T26 (em milissegundos).
Retorna o valor do timer T27
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T27
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T27 (em milissegundos).
Retorna o valor do timer T28
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T28
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T28 (em milissegundos).
Retorna o valor do timer T34
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T34
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T34 (em milissegundos).
Retorna o valor do timer T36
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T36
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T36 (em milissegundos).
Retorna o valor do timer T37
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T37
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T37 (em milissegundos).
Retorna o valor do timer T38
- Tipo de requisição:
- QUERY: ss7.isup.circuitGroup.X.cic.Y.T38
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Observação: Valor do timer T38 (em milissegundos).
Retorna o número de circuitos licenciados
- Tipo de requisição:
- QUERY: ss7.isup.license.circuitCount
- Parâmetros: Nenhum
- Retorno: string
Indica se o circuito com identificador global de número X está licenciado
- Tipo de requisição:
- QUERY: ss7.isup.license.cid.X
- Parâmetros: X = Número do circuito
- Retorno: string (true ou false)
MTP3
Retorna uma lista com os nomes dos linksets presentes no arquivo de configuração
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
Retorna o identificador do linkset
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.id
- Parâmetros: X = Nome do linkset
- Retorno: int
Retorna o point code de origem
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.originPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
Retorna o point code adjacente
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.adjacentPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
Retorna o indicador de rede
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.networkIndicator
- Parâmetros: X = Nome do linkset
- Retorno: string
Indica se o linkset está ativo
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.available
- Parâmetros: X = Nome do linkset
- Retorno: string (true ou false)
Retorna uma lista com os nomes dos links pertencentes ao linkset
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link
- Parâmetros: X = Nome do linkset
- Retorno: string
Retorna o nome do link MTP2
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.mtp2
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string
Retorna o SLC
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.slc
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
Retorna o valor do timer Q.707 T1
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.Q707T1
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
Retorna o valor do timer Q.707 T2
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.Q707T2
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
Retorna o valor do timer Q.704 T17
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.Q704T17
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
Indica se o link está disponível
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.available
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se o link está em serviço
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.inService
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se a ativação está em progresso
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.activationInProgress
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se o link está ativado
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.activated
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se o link está bloqueado
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.blocked
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se o link está no estado inhibited
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.inhibited
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Indica se o link está no estado remote processor outage
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.link.Y.remoteProcessorOutage
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
Retorna uma lista com os nomes das rotas existentes
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
Retorna o point code cadastrado
- Tipo de requisição:
- QUERY: ss7.mtp3.route.X.pointCode
- Parâmetros: X = Nome da rota
- Retorno: string
Retorna uma lista com os nomes dos linksets da rota X
- Tipo de requisição:
- QUERY: ss7.mtp3.route.X.linkSet
- Parâmetros: X = Nome da rota
- Retorno: string
MTP2
Retorna uma lista com os nomes dos links MTP2 presentes no arquivo de configuração
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
Retorna o endereço
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.address
- Parâmetros: X = Nome do link
- Retorno: string
Retorna o dispositivo
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.device
- Parâmetros: X = Nome do link
- Retorno: int
Retorna o link
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.link
- Parâmetros: X = Nome do link
- Retorno: int
Retorna o timeslot
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.timeslot
- Parâmetros: X = Nome do link
- Retorno: int
Indica se o link é passivo
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.passive
- Parâmetros: X = Nome do link
- Retorno: string (true ou false)
Retorna o valor do timer T1
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T1
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T1 (em milissegundos).
Retorna o valor do timer T2
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T2
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T2 (em milissegundos).
Retorna o valor do timer T3
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T3
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T3 (em milissegundos).
Retorna o valor do timer T5
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T5
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T5 (em milissegundos).
Retorna o valor do timer T6
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T6
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T6 (em milissegundos).
Retorna o valor do timer T7
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T7
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer T7 (em milissegundos).
Retorna o valor do timer proving emergency
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.ProvingEmergency
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer proving emergency (em milissegundos).
Retorna o valor do timer proving normal
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.ProvingNormal
- Parâmetros: X = Nome do link
- Retorno: int
- Observação: Valor do timer proving normal (em milissegundos).
Point Code
Retorna uma lista com os nomes dos point codes presentes no arquivo de configuração
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
Retorna o primeiro campo do point code
- Tipo de requisição:
- QUERY: ss7.pointCode.X.first
- Parâmetros: X = Nome do point code
- Retorno: int
Retorna o segundo campo do point code
- Tipo de requisição:
- QUERY: ss7.pointCode.X.middle
- Parâmetros: X = Nome do point code
- Retorno: int
Retorna o último campo do point code
- Tipo de requisição:
- QUERY: ss7.pointCode.X.last
- Parâmetros: X = Nome do point code
- Retorno: int
Comandos Disponíveis
Reinicia o link
- Tipo de requisição:
- Parâmetros: X = Serial, Y = Link
Zera os contadores de erro do link
- Tipo de requisição:
- CMD: k3l.ClearLinkErrorCounter.X.Y
- Parâmetros: X = Serial, Y = Link
Bloqueia todos os canais do link
- Tipo de requisição:
- Parâmetros: X = Serial, Y = Link
Reinicia o modem
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- Parâmetros: X = Serial, Y = Canal
Zera as estatísticas do canal
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- CMD: k3l.ClearChannelStats.X.Y
- Parâmetros: X = Serial, Y = Canal
Modo Compatibilidade
Para realizar a comunicação com o KQueryServer em modo de compatibilidade, é necessário estabelecer uma conexão com o serviço através de uma conexão TCP, na porta 14130 (configurável). Nessa conexão transitam as requisições e suas respectivas respostas. Essas requisições podem ser do tipo QUERY
(que requisitam uma informação do sistema) ou CMD
(que enviam um comando) e possuem um formato específico. As requisições do tipo QUERY
podem ser concatenadas e enviadas em um único lote, o que pode diminuir consideravelmente o uso de recursos do sistema operacional em aplicações com alta demanda por informação.
Requisições Simples
QUERY <string>
Envia uma requisição simples e recebe uma resposta que pode ser verificado na página Códigos de retorno das funções.
Exemplo:
Telnet <IP_SERVIDOR>:14130
QUERY k3l.DeviceCount
Resposta: 3
CMD <string>
Envia um comando, a <string> pode ser qualquer uma das listadas na seção Códigos de retorno das funções.
Exemplo:
Telnet <IP_SERVIDOR>:14130
CMD k3l.ResetLink.12345.1
Resposta: Executed
OID <object id>
Este formato só disponível a partir da versão 3.3
|
Envia uma requisição simples utilizando o interpretador SNMP, permitindo utilizar qualquer item da MIB Khomp. Todos os resultados serão convertidos para string.
Exemplo: (requisição k3lDeviceCount)
Telnet <IP_SERVIDOR>:14130
OID .1.3.6.1.4.1.32624.2.1.2.1.0
Resposta: 3
Requisições múltiplas
Formato novo (a partir da 3.3)
Este formato só disponível a partir da versão 3.3
|
REQUISIÇÃO_SIMPLES_1;REQUISIÇÃO_SIMPLES_2; ... ;REQUISIÇÃO_SIMPLES_N
Envia requisições em lote. Como separador podem ser usados os caracteres ';' ou '|', não existe distinção entre eles, servindo somente para permitir agrupamentos na resposta, ficando sua utilização à cargo do usuário. O separador utilizado na requisição será utilizado na resposta na mesma posição. Qualquer requisição simples pode ser utilizada (QUERY, CMD ou OID). Caso alguma requisição falhe, as demais serão executadas normalmente e a que falhou será indicada por um "Query failed(<causa>)" na posição referente a mesma.
Exemplo 1:
Telnet <IP_SERVIDOR>:14130
QUERY k3l.DeviceCount;QUERY k3l.Device.Type.12345;QUERY k3l.Config.Device.12345.ChannelCount
Resposta 1: 3;18;60
Exemplo 2:
Telnet <IP_SERVIDOR>:14130
OID .1.3.6.1.4.1.32624.2.1.2.1.0|QUERY k3l.Status.Connected.12345|QUERY k3l.Status.Connected.54321
Resposta 2: 3|0|1
Formato antigo (até 3.2)
Este formato não está mais disponível a partir da versão 3.3
|
n(QUERY <string>;)n-1QUERY <string>$
Envia requisições em lote, onde n indica o número de requisições existentes no lote e '$' indica o fim da requisição. Como separador podem ser usados os caracteres ';' ou '|', não existe distinção entre eles, servindo somente para permitir agrupamentos na resposta, ficando sua utilização à cargo do usuário. Caso alguma requisição falhe, as demais serão executadas normalmente e a que falhou será indicada por um "Query failed(<causa>)" na posição referente a mesma. Se caso o indicador de fim de lote '$' não for enviado, será retornado apenas "Batch corrupted" e nenhuma requisição será executada.
Exemplo 1:
Telnet <IP_SERVIDOR>:14130
3QUERY k3l.DeviceCount;QUERY k3l.Device.Type.12345;QUERY k3l.Config.Device.12345.ChannelCount$
Resposta 1: 3;18;60
Exemplo 2:
Telnet <IP_SERVIDOR>:14130
2QUERY k3l.Status.Connected.12345|QUERY k3l.Status.Connected.54321$
Resposta 2: 0|1
Exemplo 3:
Telnet <IP_SERVIDOR>:14130
3QUERY k3l.Status.Connected.12345;QUERY k3l.Device.TyASD.12345;QUERY k3l.ApiConfig.StrVersion$
Resposta 3: 1;Query failed(5);K3L API 3.0.0 - (rev: 11789)
Programando com KQueryServer
O esqueleto de um programa que interage com o KQueryServer enviando requisições e recebendo respostas pode ser visto no PseudoCódigo/C++ a seguir:
socket_handle = socket( AF_INET, SOCK_STREAM, SOL_TCP );
connect( socket_handle, IP_DO_SERVIDOR_RODANDO_KQUERYSERVER, 14130 );
for (int i = 0; i < NUMERO_DE_REQUISICOES; i++)
{
write( socket_handle, requisicao, strlen(requisicao) );
recv ( socket_handle, $resposta, TAMANHO_BUFFER_RESPOSTA, MSG_WAITALL );
}
close( socket_handle );
Utilizando snmpd como proxy para o KQueryServer
Para integrar o KQueryServer à uma solução de SNMP já utilizada pelo usuário, será necessário somente configurar o seu agente atual para utilizar o KQueryServer como um sub-agente. Para isso, basta adicionar no arquivo snmpd.conf:
rocommunity public
proxy -v 1 -c khomp localhost:14161 .1.3.6.1.4.1.32624
aonde:
- 'khomp' representa a comunidade (ao invés de 'public'),
- 'localhost' indica em qual máquina o KQueryServer está rodando (pode também ser utilizado um IP, caso não seja na mesma máquina),
- '14161' é a porta aonde o KQueryServer por padrão esperará requisições SNMP (a porta 14130 continuará funcionando para as requisições originais do KQueryServer) e
- '.1.3.6.1.4.1.32624' é a OID base que representa a Khomp na IANA (Internet Assigned Numbers Authority).
Assim, todas as requisições que comecem com '1.3.6.1.4.1.32624' serão redirecionadas para o KQueryServer que esteja rodando no IP e porta especificados. O KQueryServer terá as mesmas funcionalidades do KSNMP (com a adição de algumas requisições atualmente não disponíveis).