Resumo
O KQueryServer é um serviço que permite a obtenção de dados referentes à configuração e estado atual de dispositivos e da API K3L, além do envio de alguns comandos. Isso é feito através de requisições em formato pré-definido baseado no KSNMP, um agente do protocolo SNMP que fornece as informações da API K3L para consulta, no qual uma requisição é formada por números separados por pontos. Diferentemente, o KQueryServer utiliza-se de mnemônicos para indicar o dado que deseja consultar, porém respeitando a organização definida pelo KSNMP. Por exemplo, "k3l.DeviceCount" requisita a quantidade de dispositivos configurados e "k3l.DeviceType.4242" requisita o tipo do dispositivo cujo número de série é 4242. Dessa forma, pode-se obter dados do sistema através de uma conexão TCP e assim utilizar essa ferramenta para construção de scripts e/ou aplicações Web.
Para realizar a comunicação com o KQueryServer, é necessário estabelecer uma conexão com o serviço através de um Socket TCP, que por padrão utiliza a porta 14130. 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 como pode ser visto na seção EBS. Para informações detalhadas sobre como enviar requisições e receber respostas, vide a seção Utilizando o KQueryServer.
O KQueryServer também pode ser usado para responder requisições como um Agente Proxy para o SNMP. Dessa forma, o KQueryServer funcionará como um sub-agente compatível com Net-SNMP, trabalhando em conjunto com outros agentes presentes no sistema. A seção Utilizando o KQueryServer como Proxy SNMP explica como integrar ao Net-SNMP e a seção Requisições Disponíveis mostra a requisição SNMP equivalente a cada requisição do KQueryServer.
Na versão 3.3 da API, a interface SNMP foi reformulada para possiblitar sua formalização na forma da RFC 1213 (Management Information Base - MIB-II). 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.
Formatos de Requisição
Requisições Simples
QUERY <string>
Envia uma requisição simples, a <string> pode ser qualquer uma das listadas na seção Códigos de retorno das funções.
Exemplo:
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:
CMD k3l.ResetLink.12345.1
Resposta:
Executed
OID <object id>
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):
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:
QUERY k3l.DeviceCount;QUERY k3l.Device.Type.12345;QUERY k3l.Config.Device.12345.ChannelCount
Resposta 1:
3;18;60
Exemplo 2:
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:
3QUERY k3l.DeviceCount;QUERY k3l.Device.Type.12345;QUERY k3l.Config.Device.12345.ChannelCount$
Resposta 1:
3;18;60
Exemplo 2:
2QUERY k3l.Status.Connected.12345|QUERY k3l.Status.Connected.54321$
Resposta 2:
0|1
Exemplo 3:
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)
Requisições Disponíveis
As requisições estão apresentadas como Query | SNMP | MIB, ou seja, o lado esquerdo do '|' mostra a query no formato de mnemônicos e, no centro, o formato correspondente para o SNMP, por fim à direita o formato utilizando a MIB. Algumas não estão disponíveis em todos os formatos.
Importante! 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).
Importante! Uma requisição SNMP legada deve ser iniciada por 1.3.6.1.4.1.32624.
seguido pelas sequências númericas apresentadas a seguir ou KHOMP-MIB::legacy.
, sendo necessário remover o primeiro dígito da sequencia numérica.
Configuração
k3l.DeviceCount | 1.1.0 | KHOMP-MIB::k3lDeviceCount.0
- Parâmetros: Nenhum
- Retorno: int
- Descrição: Quantidade de dispositivos configurados
k3l.DeviceType.X | 1.2.X.0 | KHOMP-MIB::k3lDeviceType.X
- Parâmetros: X = Serial
- Retorno: int (KDeviceType)
- Descrição: Tipo do dispositivo X
k3l.Config.Device.X.LinkCount | 1.3.1.X.1.0 | KHOMP-MIB::k3lDeviceLinkCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de Links do dispositivo
k3l.Config.Device.X.ChannelCount | 1.3.1.X.2.0 | KHOMP-MIB::k3lDeviceChannelCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais do dispositivo
k3l.Config.Device.X.EnabledChannelCount | 1.3.1.X.3.0 | KHOMP-MIB::k3lDeviceChannelCountEnabled.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais habilitados no dispositivo
k3l.Config.Device.X.EnabledChannelCount | 1.3.1.X.3.0 | KHOMP-MIB::k3lDeviceChannelCountEnabled.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais habilitados no dispositivo
KHOMP-MIB::k3lDeviceChannelGroupCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de grupos no dispositivo
KHOMP-MIB::k3lDeviceStatsIncoming.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas entrantes
KHOMP-MIB::k3lDeviceStatsOutgoing.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas saintes
KHOMP-MIB::k3lDeviceOutgoingCompleted.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas saintes completadas
KHOMP-MIB::k3lDeviceOutgoingError.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas saintes
KHOMP-MIB::k3lDeviceRemoteDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas que sofreram desconexão remota
KHOMP-MIB::k3lDeviceLocalDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros que sofreram desconexão local
KHOMP-MIB::k3lDeviceCallFailBusy.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas ocupadas
KHOMP-MIB::k3lDeviceCallFailNoAnswer.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas sem resposta
KHOMP-MIB::k3lDeviceCallFailRejected.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas rejeitadas
KHOMP-MIB::k3lDeviceCallFailChangedNumber .X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas cujo numero de destino mudou
KHOMP-MIB::k3lDeviceCallFailInvalidNumber.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas de numero invalido
KHOMP-MIB::k3lDeviceCallFailOutOfService.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas fora de serviço
KHOMP-MIB::k3lDeviceCallFailCongestion.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros devido a congestionamento na linha
KHOMP-MIB::k3lDeviceCallFailNetworkFailure.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros devido a falha na rede
KHOMP-MIB::k3lDeviceCallFailOther.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas (outros)
KHOMP-MIB::k3lConsolidatedDevicesChannelCount
- Retorno: int
- Descrição: Quantidade de canais consolidados por dispositivos
KHOMP-MIB::k3lConsolidatedDevicesChannelCountEnabled
- Retorno: int
- Descrição: Quantidade consolidada de canais habilitados por dispositivos
KHOMP-MIB::k3lConsolidatedDevicesChannelCountIdle
- Retorno: int
- Descrição: Quantidade consolidada de canais disponiveis por dispositivos
KHOMP-MIB::k3lConsolidatedDevicesChannelCountFail
- Retorno: int
- Descrição: Quantidade consolidada de falha de canais por dispositivos
KHOMP-MIB::k3lConsolidatedDevicesChannelCountBusy
- Retorno: int
- Descrição: Quantidade consolidada de canais ocupados por dispositivos
KHOMP-MIB::k3lDeviceLinkChannelCount.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais do link
KHOMP-MIB::k3lDeviceLinkChannelCountEnabled.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais habilitados no link
KHOMP-MIB::k3lDeviceLinkChannelCountIdle.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais disponíveis no link
KHOMP-MIB::k3lDeviceLinkChannelCountFail.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais com falha no link
KHOMP-MIB::k3lDeviceLinkChannelCountBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais ocupados no link
KHOMP-MIB::k3lDeviceLinkStatsIncoming.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de chamadas entrantes no link
KHOMP-MIB::k3lDeviceLinkStatsOutgoing.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de chamadas saintes no link
KHOMP-MIB::k3lDeviceLinkOutgoingCompleted.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de chamadas saintes completadas no link
KHOMP-MIB::k3lDeviceLinkOutgoingError.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas saintes no link
KHOMP-MIB::k3lDeviceLinkRemoteDisconnect.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de chamadas no link que sofreram desconexão remota
KHOMP-MIB::k3lDeviceLinkLocalDisconnect.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros no link que sofreram desconexão local
KHOMP-MIB::k3lDeviceLinkCallFailBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas ocupadas
KHOMP-MIB::k3lDeviceLinkCallFailNoAnswer.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas sem resposta
KHOMP-MIB::k3lDeviceLinkCallFailRejected.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas rejeitadas
KHOMP-MIB::k3lDeviceLinkCallFailChangedNumber.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas cujo numero de destino mudou
KHOMP-MIB::k3lDeviceLinkCallFailInvalidNumber.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas de numero invalido
KHOMP-MIB::k3lDeviceLinkCallFailOutOfService.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas fora de serviço
KHOMP-MIB::k3lDeviceLinkCallFailCongestion.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros devido a congestionamento na linha
KHOMP-MIB::k3lDeviceLinkCallFailNetworkFailure.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros devido a falha na rede
KHOMP-MIB::k3lDeviceLinkCallFailOther.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas (outros)
k3l.Config.Device.X.DeviceModel | 1.3.1.X.7.0 | KHOMP-MIB::k3lDeviceModel.X
- Parâmetros: X = Serial
- Retorno: int (K*DeviceModel)
- Descrição: Modelo do dispositivo
k3l.Config.Device.X.VoIPChannelCount | 1.3.1.X.12.0 | KHOMP-MIB::k3lDeviceSipChannelCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais VoIP do dispositivo
k3l.Config.Device.X.SerialNumber | 1.3.1.X.16.0 | KHOMP-MIB::k3lDeviceSerial.X
- Parâmetros: X = ID na K3L
- Retorno: int
- Descrição: Número Serial do dispositivo
k3l.Config.Link.X.Y.Signaling | 1.3.2.X.Y.1.0 | KHOMP-MIB::k3lDeviceLinkSignaling.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int (KSignaling)
- Descrição: Sinalização do link
k3l.Config.Link.X.Y.Name | 1.3.2.X.Y.7.0 | KHOMP-MIB::k3lDeviceLinkDescr.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: string
- Descrição: Nome atribuído ao link na configuração
k3l.Config.Link.X.Y.OperatingMode | 1.3.2.X.Y.8.0 | KHOMP-MIB::k3lDeviceLinkOperatingMode.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: string
- Descrição: Retorna 'E1' ou 'T1' para indicar o modo de operação do link
k3l.Config.Link.X.Y.ReceivingClock | 1.3.2.X.Y.9.0 | KHOMP-MIB::k3lDeviceLinkReceivingClock.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: bool
- Descrição: Indica se o link está recebendo a sincronização
k3l.Config.Channel.X.Y.Signaling | 1.3.3.X.Y.1.0 | KHOMP-MIB::k3lDeviceChannelSignaling.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KSignaling)
- Descrição: Sinalização do canal
k3l.Config.Api.StrVersion | 1.3.5.7.0 | KHOMP-MIB::k3lVersionString.0
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Versão da API
k3l.Config.Api.R2Country | 1.3.5.8.0 | KHOMP-MIB::k3lConfigurationR2Country.0
- Parâmetros: Nenhum
- Retorno: int (KR2Country)
- Descrição: País do padrão de troca de MFC utilizado pelo R2
k3l.Config.EBS.X.String | 1.3.6.X.1.0 | KHOMP-MIB::k3lDeviceDescr.X
Este recurso está disponível a partir da versão: 3.1.
|
- Parâmetros: X = Serial
- Retorno: string
- Descrição: Nome da EBS Modular
k3l.Config.EBS.X.GSMChannels | 1.3.6.X.2.0 | KHOMP-MIB::k3lDeviceGsmChannelCount.X
Este recurso está disponível a partir da versão: 3.1.
|
- Parâmetros: X = Serial
- Retorno: int,int,...,int
- Descrição: Números dos canais GSM presentes no EBS Modular
k3l.Config.EBS.X.IP | 1.3.6.X.3.0 | KHOMP-MIB::k3lDeviceEbsIP.X
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial
- Retorno: string
- Descrição: Endereço IP do EBS
KHOMP-MIB::k3lDeviceChannelGroupIndex.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Índice do grupo
KHOMP-MIB::k3lDeviceChannelGroupType.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Tipo do grupo
KHOMP-MIB::k3lDeviceChannelGroupFirstChannel.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Índice do primeiro canal do grupo
KHOMP-MIB::k3lDeviceChannelGroupChannelCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais do grupo
KHOMP-MIB::k3lDeviceChannelGroupChannelIdle.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais disponiveis do grupo
KHOMP-MIB::k3lDeviceChannelGroupChannelFail.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais em falha do grupo
KHOMP-MIB::k3lDeviceChannelGroupChannelBusy.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais ocupados do grupo
Estado
KHOMP-MIB::k3lDeviceLinkOperStatus.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: bool
- Descrição: Estado simplificado do link (UP,DOWN)
k3l.Status.Link.X.Y.E1 | 1.4.1.X.Y.1.0 | KHOMP-MIB::k3lDeviceLinkAlarm.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int (KE1Status)
- Descrição: Estado do link
k3l.Status.Link.X.Y.Z.E1 | 1.4.1.X.Y.Z.1.0 | KHOMP-MIB::k3lDeviceLinkAlarm.X.Y
- Parâmetros: X = Serial, Y = Link, Z = Ignorado
- Retorno: int (KE1Status)
- Descrição: Estado do link
k3l.Status.Link.X.Y.Z.Channels | 1.4.1.X.Y.Z.2.0 | KHOMP-MIB::k3lDeviceE1ChannelStatus.X.Z
- Parâmetros: X = Serial, Y = Link, Z = Canal
- Retorno: int (KE1ChannelStatus)
- Descrição: Estado do canal
KHOMP-MIB::k3lDeviceHILinkOperStatus.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Rx do link
- Retorno: bool
- Descrição: Retorna, separadamente, o estado simplificado (UP,DOWN) dos Rx de um link de gravação passiva. 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.
k3l.Status.Link.X.Y.HI | 1.4.1.X.Y.3.0 | KHOMP-MIB::k3lDeviceHILinkAlarm.X.Y
Este recurso está disponível a partir da versão: 3.1.
|
- Parâmetros: X = Serial, Y = Rx do link
- Retorno: int (KE1Status)
- Descrição: Retorna, separadamente, o estado dos Rx de um link de gravação passiva. 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.
k3l.Status.Channel.X.Y.CallStatus | 1.4.2.X.Y.1.0 | KHOMP-MIB::k3lDeviceChannelCallStatus.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KCallStatus)
- Descrição: Estado da chamada
k3l.Status.Channel.X.Y.AudioStatus | 1.4.2.X.Y.2.0 | KHOMP-MIB::k3lDeviceChannelAudioStatus.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KDetectionTone)
- Descrição: Estado do áudio no canal
k3l.Status.Channel.X.Y.AddInfo | 1.4.2.X.Y.3.0 | KHOMP-MIB::k3lDevice*ChannelStatus.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (K*ChannelStatus)
- Descrição: Informações adicionais sobre o estado do canal. 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.
k3l.Status.Channel.X.Y.EnabledFeatures | 1.4.2.X.Y.4.0 | KHOMP-MIB::k3lDeviceChannelEnabledFeatures.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KChannelFeatures)
- Descrição: Recursos habilitados
k3l.Status.Channel.X.TotalFail | 1.4.2.X.5.0 | KHOMP-MIB::k3lDeviceCountFail.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em falha
k3l.Status.Channel.X.TotalIdle | 1.4.2.X.6.0 | KHOMP-MIB::k3lDeviceCountIdle.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em espera
k3l.Status.Channel.X.TotalCall | 1.4.2.X.7.0 | KHOMP-MIB::k3lDeviceCountBusy.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em chamada
KHOMP-MIB::k3lDeviceLinkCountFail.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em falha no link
KHOMP-MIB::k3lDeviceLinkCountIdle.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em espera no link
KHOMP-MIB::k3lDeviceLinkCountBusy.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em chamada no link
k3l.Status.Channel.X.Y.DialNumber | 1.4.2.X.8.0 | KHOMP-MIB::k3lDeviceChannelDestinationAddress.X.Y
Este recurso está disponível a partir da versão: 3.2.
|
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
- Descrição: Número discado na ligação corrente
k3l.Status.Channel.X.Y.CallDuration | 1.4.2.X.9.0 | KHOMP-MIB::k3lDeviceChannelCallDuration.X.Y
Este recurso está disponível a partir da versão: 3.2.
|
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
- Descrição: Duração da ligação corrente em milissegundos
k3l.Status.Channel.X.Y.RecordingStatus | 1.4.2.X.10.0 | KHOMP-MIB::k3lDeviceChannelRecording.X.Y
Este recurso está disponível a partir da versão: 3.2.
|
- Parâmetros: X = Serial, Y = Canal
- Retorno: bool
- Descrição: Indica se o canal está gravando
k3l.Status.Channel.X.Y.AverageCallTime | 1.4.2.X.11.0 | KHOMP-MIB::k3lDeviceChannelAverageCallTime.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
- Descrição: Média da duração das ligações do canal, em milissegundos
k3l.Status.Channel.X.Y.OriginAddress | 1.4.2.X.12.0 | KHOMP-MIB::k3lDeviceChannelOriginAddress.X.Y
Este recurso está disponível a partir da versão: 3.3.1.
|
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
- Descrição: Número de origem na ligação corrente
k3l.Status.LinkErrorCounter.X.Y | 1.4.4.X.Y.0 | KHOMP-MIB::k3lDeviceLinkErrorCount*.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int[16] (KLinkErrorCounter)
- Descrição: Contadores de erros do link. A KHOMP-MIB fornece um OID para cada contador de erro. Os seguintes OIDs estão disponíveis: k3lDeviceLinkErrorCountChangesToLock, k3lDeviceLinkErrorCountLostOfSignal, 3lDeviceLinkErrorCountAlarmNotification, k3lDeviceLinkErrorCountLostOfFrame, k3lDeviceLinkErrorCountLostOfMultiframe, k3lDeviceLinkErrorCountRemoteAlarm, k3lDeviceLinkErrorCountSlipAlarm, k3lDeviceLinkErrorCountPRBS, k3lDeviceLinkErrorCountWrongEBits, k3lDeviceLinkErrorCountJitterVariation, k3lDeviceLinkErrorCountFramesWithoutSync, k3lDeviceLinkErrorCountMultiframeSignal, k3lDeviceLinkErrorCountFrameError, k3lDeviceLinkErrorCountBipolarViolation, k3lDeviceLinkErrorCountCRC4.
k3l.Status.GSMChannel.X.Y.SignalStrength.Z | 1.4.5.X.Y.1.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelSignalStrength.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int [0 - 100]
- Retorno: 255 SIM CARD não registrado
- Descrição: Nível de sinal
k3l.Status.GSMChannel.X.Y.ErrorRate.Z | 1.4.5.X.Y.2.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelErrorRate.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int [0 - 7] (0 = sem erros, 7 = altíssima taxa de erros)
- Descrição: Taxa de erros
k3l.Status.GSMChannel.X.Y.RegistryStatus.Z | 1.4.5.X.Y.3.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelRegistryStatus.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int (KGsmRegistryStatus)
- Descrição: Estado do registro
k3l.Status.GSMChannel.X.Y.OperName.Z | 1.4.5.X.Y.4.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelOperName.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Nome da operadora
k3l.Status.GSMChannel.X.Y.UnreadSmsCount.Z | 1.4.5.X.Y.5.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelUnreadSmsMessages.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Descrição: Número de SMS não lidos
k3l.Status.GSMChannel.X.Y.EnabledFeatures.Z | 1.4.5.X.Y.6.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelEnabledFeatures.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Descrição: Recursos habilitados
k3l.Status.GSMChannel.X.Y.IMEI.Z | 1.4.5.X.Y.7.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelImei.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número IMEI (International Mobile Equipment Identity / Identificação Internacional de Equipamento Móvel).
k3l.Status.GSMChannel.X.Y.SIM.Z | 1.4.5.X.Y.8.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelSim.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: char
- Descrição: SIM card atualmente selecionado.
k3l.Status.GSMChannel.X.Y.CallStatus.Z | 1.4.5.X.Y.9.Z.0 | KHOMP-MIB::k3lDeviceGsmCallStatus.X.Y.Z
- Parâmetros: X = Serial, Y = Canal, Z = Chamada
- Retorno: int,int,string,int (K3L_GSM_CALL_STATUS)
- Descrição: Estado da chamada Z no canal Y
k3l.Status.GSMChannel.X.Y.IMSI.Z | 1.4.5.X.Y.10.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelImsi.X.Y
Este recurso está disponível a partir da versão: 3.2.4.
|
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número IMSI (International Mobile Subscriber Identity)
k3l.Status.GSMChannel.X.Y.ICCID.Z | 1.4.5.X.Y.11.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelIccid.X.Y
Este recurso está disponível a partir da versão: 3.2.4.
|
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número ICCID (Integrated Circuit Card ID)
k3l.Status.GSMChannel.X.Y.MSISDN.Z | 1.4.5.X.Y.12.Z.0 | KHOMP-MIB::k3lDeviceGsmChannelMsisdn.X.Y
Este recurso está disponível a partir da versão: 3.3.1.
|
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número MSISDN (Mobile Systems ISDN Number)
k3l.Status.Connected.X | 1.4.6.X.0
- Parâmetros: X = Serial
- Retorno: bool
- Descrição: Estado (1=conectado, 0=desconectado)
Estatística
k3l.ChannelStats.X.Y | 1.5.X.Y.0 | KHOMP-MIB::k3lDeviceChannelStats*.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int[16] (KGeneralCallStatIndex, KFailedCallStatIndex)
- Descrição: Estatísticas do canal. 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.
VoIP
SIP
voip.GW.Profile.X.LocalAddress
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Endereço local utilizado para preencher as mensagens SIP.
voip.GW.Profile.X.LocalPort
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: int
- Descrição: Porta local utilizada para preencher as mensagens SIP.
voip.GW.Profile.X.TransportType
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Tipo de transporte (UDP ou TCP) utilizado para preencher as mensagens SIP.
voip.GW.Profile.X.RTPAddress
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Endereço local utilizado para a troca de áudio RTP.
voip.GW.Profile.X.User
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: "Address of Record" utilizado no registro.
voip.GW.Profile.X.AuthorizationUser
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Parâmetro "username" utilizado no campo "Authorization".
voip.GW.Profile.X.Realm
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Parâmetro "realm" utilizado no campo "Authorization".
voip.GW.Profile.X.Domain
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Endereço do servidor onde será feito o registro.
voip.GW.Profile.X.DomainPort
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: int
- Descrição: Porta do servidor onde será feito o registro.
voip.GW.Profile.X.Proxy
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Endereço do proxy por onde a mensagem deve passar antes de chegar no servidor.
voip.GW.Profile.X.ProxyPort
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: int
- Descrição: Porta do proxy por onde a mensagem deve passar antes de chegar no servidor.
voip.GW.Profile.X.Registered
- Parâmetros: X = SIP Profile id, retornado por EV_SIP_REGISTER_INFO
- Retorno: string
- Descrição: Indica se o profile está registrado ou não em um servidor.
RTP
voip.Media.RTPStatus.X.Transmit.LastSequenceNumber
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de sequência do último pacote RTP enviado.
voip.Media.RTPStatus.X.Transmit.PacketCount
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de pacotes RTP enviados.
voip.Media.RTPStatus.X.Transmit.OctetCount
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número total de octetos RTP enviados.
voip.Media.RTPStatus.X.Transmit.PacketLost
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de pacotes RTP enviados perdidos.
voip.Media.RTPStatus.X.Receive.InitialSequenceNumber
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de sequência do primeiro pacote RTP recebido.
voip.Media.RTPStatus.X.Receive.LastSequenceNumber
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de sequência do último pacote RTP recebido.
voip.Media.RTPStatus.X.Receive.PacketCount
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Número de pacotes RTP recebidos.
voip.Media.RTPStatus.X.Receive.DroppedCount
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Quantidade total de pacotes entrantes perdidos.
voip.Media.RTPStatus.X.Receive.LastDroppedCount
- Parâmetros: X = Canal SIP em chamada
- Retorno: int
- Descrição: Quantidade de pacotes entrantes perdidos em sequência. Ao receber um pacote com o número de sequência esperado, este contador é zerado.
SS7
ISUP
ss7.isup.circuitGroup
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos grupos de circuitos presentes no arquivo de configuração.
ss7.isup.circuitGroup.X.opc
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
- Descrição: Retorna o point code de origem (originating point code).
ss7.isup.circuitGroup.X.dpc
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
- Descrição: Retorna o point code de destino (destination point code).
ss7.isup.circuitGroup.X.baseCIC
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o código de identificação do circuito (circuit identification code) inicial.
ss7.isup.circuitGroup.X.passive
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
- Descrição: Indica se representa um grupo de sinalização passiva.
ss7.isup.circuitGroup.X.circuitCount
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o número de circuitos.
ss7.isup.circuitGroup.X.timeslotMap
- Parâmetros: X = Nome do grupo de circuito
- Retorno: hex
- Descrição: Retorna o mapa de timeslot.
ss7.isup.circuitGroup.X.address
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
- Descrição: Retorna o endereço IP onde está localizado o grupo de circuito.
ss7.isup.circuitGroup.X.device
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o número da placa, localizada na máquina informada pelo campo address.
ss7.isup.circuitGroup.X.link
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o número do link, localizado na máquina e placa informadas pelos campos address e device.
ss7.isup.circuitGroup.X.CCActivated
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
- Descrição: Indica se o call control do grupo está ativo. 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).
ss7.isup.circuitGroup.X.LinkActivated
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
- Descrição: Indica se o link da placa está ativo (informado pelo HDLC).
ss7.isup.circuitGroup.X.MTPResumed
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string (true ou false)
- Descrição: Indica se algum link mtp3 está ativo para o grupo de circuito (informado pelo MTP3).
ss7.isup.circuitGroup.X.TResume
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o valor do timer resume (em milissegundos). Este timer é utilizado para consultar o status do grupo de circuito adjacente após a indicação de que o link mtp3 está ativo.
ss7.isup.circuitGroup.X.TPause
- Parâmetros: X = Nome do grupo de circuito
- Retorno: int
- Descrição: Retorna o valor do timer pause (em milissegundos). Este timer é utilizado para bloquear os canais do call control após a indicação de que o link mtp3 está desativo.
ss7.isup.circuitGroup.X.cic
- Parâmetros: X = Nome do grupo de circuito
- Retorno: string
- Descrição: Retorna uma lista com os valores dos códigos de identificação do circuito (circuit identification codes) do grupo de circuito.
ss7.isup.circuitGroup.X.cic.Y.cid
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do identificador global único do circuito (utilizado internamente).
ss7.isup.circuitGroup.X.cic.Y.callStatus
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: string
- Descrição: Retorna o status presente na máquina de estados do SS7 do circuito. O status pode apresentar as seguintes informações: Free, Incoming call, Outgoing call, Incoming lock e Outgoing lock.
ss7.isup.circuitGroup.X.cic.Y.T1
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T1 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T5
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T5 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T6
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T6 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T7
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T7 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T8
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T8 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T9
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T9 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T12
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T12 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T13
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T13 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T14
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T14 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T15
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T15 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T16
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T16 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T17
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T17 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T18
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T18 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T19
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T19 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T20
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T20 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T21
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T21 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T22
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T22 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T23
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T23 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T24
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T24 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T25
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T25 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T26
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T26 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T27
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T27 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T28
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T28 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T34
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T34 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T36
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T36 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T37
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T37 (em milissegundos).
ss7.isup.circuitGroup.X.cic.Y.T38
- Parâmetros: X = Nome do grupo de circuito, Y = Número do circuito
- Retorno: int
- Descrição: Retorna o valor do timer T38 (em milissegundos).
ss7.isup.license.circuitCount
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna o número de circuitos licenciados.
ss7.isup.license.cid.X
- Parâmetros: X = Número do circuito
- Retorno: string (true ou false)
- Descrição: Indica se o circuito com identificador global de número X está licenciado.
MTP3
ss7.mtp3.linkSet
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos linksets presentes no arquivo de configuração.
ss7.mtp3.linkSet.X.id
- Parâmetros: X = Nome do linkset
- Retorno: int
- Descrição: Retorna o identificador do linkset.
ss7.mtp3.linkSet.X.originPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o point code de origem (origin point code).
ss7.mtp3.linkSet.X.adjacentPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o point code adjacente (adjacent point code).
ss7.mtp3.linkSet.X.networkIndicator
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o indicador de rede (network indicator).
ss7.mtp3.linkSet.X.available
- Parâmetros: X = Nome do linkset
- Retorno: string (true ou false)
- Descrição: Indica se o linkset está ativo.
ss7.mtp3.linkSet.X.link
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos links pertencentes ao linkset.
ss7.mtp3.linkSet.X.link.Y.mtp2
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string
- Descrição: Retorna o nome do link MTP2.
ss7.mtp3.linkSet.X.link.Y.slc
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
- Descrição: Retorna o SLC.
ss7.mtp3.linkSet.X.link.Y.Q707T1
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer Q.707 T1 (em milissegundos).
ss7.mtp3.linkSet.X.link.Y.Q707T2
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer Q.707 T2 (em milissegundos).
ss7.mtp3.linkSet.X.link.Y.Q704T17
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer Q.704 T17 (em milissegundos).
ss7.mtp3.linkSet.X.link.Y.available
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está disponível.
ss7.mtp3.linkSet.X.link.Y.inService
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está em serviço.
ss7.mtp3.linkSet.X.link.Y.activationInProgress
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se a ativação está em progresso.
ss7.mtp3.linkSet.X.link.Y.activated
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está ativado.
ss7.mtp3.linkSet.X.link.Y.blocked
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está bloqueado.
ss7.mtp3.linkSet.X.link.Y.inhibited
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está no estado inhibited.
ss7.mtp3.linkSet.X.link.Y.remoteProcessorOutage
- Parâmetros: X = Nome do linkset, Y = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link está no estado remote processor outage.
ss7.mtp3.route
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes das rotas existentes.
ss7.mtp3.route.X.pointCode
- Parâmetros: X = Nome da rota
- Retorno: string
- Descrição: Retorna o point code cadastrado.
ss7.mtp3.route.X.linkSet
- Parâmetros: X = Nome da rota
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos linksets da rota X.
MTP2
ss7.mtp2.link
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos links MTP2 presentes no arquivo de configuração.
ss7.mtp2.link.X.address
- Parâmetros: X = Nome do link
- Retorno: string
- Descrição: Retorna o endereço.
ss7.mtp2.link.X.device
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o dispositivo.
ss7.mtp2.link.X.link
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o link.
ss7.mtp2.link.X.timeslot
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o timeslot.
ss7.mtp2.link.X.passive
- Parâmetros: X = Nome do link
- Retorno: string (true ou false)
- Descrição: Indica se o link é passivo.
ss7.mtp2.link.X.T1
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T1 (em milissegundos).
ss7.mtp2.link.X.T2
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T2 (em milissegundos).
ss7.mtp2.link.X.T3
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T3 (em milissegundos).
ss7.mtp2.link.X.T5
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T5 (em milissegundos).
ss7.mtp2.link.X.T6
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T6 (em milissegundos).
ss7.mtp2.link.X.T7
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer T7 (em milissegundos).
ss7.mtp2.link.X.ProvingEmergency
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer proving emergency (em milissegundos).
ss7.mtp2.link.X.ProvingNormal
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o valor do timer proving normal (em milissegundos).
Point Code
ss7.pointCode
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos point codes presentes no arquivo de configuração.
ss7.pointCode.X.first
- Parâmetros: X = Nome do point code
- Retorno: int
- Descrição: Retorna o primeiro campo do point code.
ss7.pointCode.X.middle
- Parâmetros: X = Nome do point code
- Retorno: int
- Descrição: Retorna o segundo campo do point code.
ss7.pointCode.X.last
- Parâmetros: X = Nome do point code
- Retorno: int
- Descrição: Retorna o último campo do point code.
Comandos Disponíveis
k3l.ResetLink.X.Y
- Parâmetros: X = Serial, Y = Link
- Descrição: Reinicia o link
k3l.ClearLinkErrorCounter.X.Y
- Parâmetros: X = Serial, Y = Link
- Descrição: Zera os contadores de erro do link
k3l.BlockLink.X.Y
- Parâmetros: X = Serial, Y = Link
- Descrição: Bloqueia todos os canais do link
k3l.ResetModem.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Canal
- Descrição: Reinicia o modem
k3l.ClearChannelStats.X.Y
Este recurso está disponível a partir da versão: 3.3.
|
- Parâmetros: X = Serial, Y = Canal
- Descrição: Zera as estatísticas do canal
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 o KQueryServer como Proxy SNMP
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).