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.
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.
Na 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). 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::
, na qual requisita ao servidor a quantidade de dispositivos configurados.
Exemplo 1:
snmpget -v1 -c khomp <IP_SERVIDOR>:14161 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 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
Configuração
Quantidade de dispositivos configurados
- Tipos de requisições:
- QUERY: k3l.DeviceCount
- SNMP Legado: 1.1.0
- MIB: KHOMP-MIB::k3lDeviceCount.0
- Parâmetros: Nenhum
- Retorno: int
- Descrição: Quantidade de dispositivos configurados
Tipo do dispositivo
- Tipos de requisições:
- Query: k3l.DeviceType.X
- SNMP Legado: 1.2.X.0
- MIB: KHOMP-MIB::k3lDeviceType.X
- Parâmetros: X = Serial
- Retorno: int (KDeviceType)
- Descrição: Tipo do dispositivo X
Quantidade de Links do dispositivo
- Tipos de requisições:
- Query: k3l.Config.Device.X.LinkCount
- SNMP Legado: 1.3.1.X.1.0
- MIB: KHOMP-MIB::k3lDeviceLinkCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de Links do dispositivo
Quantidade de canais do dispositivo
- Tipos de requisições:
- Query: k3l.Config.Device.X.ChannelCount
- SNMP Legado: 1.3.1.X.2.0
- MIB: KHOMP-MIB::k3lDeviceChannelCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais do dispositivo
Quantidade de canais habilitados no dispositivo
- Tipos de requisições:
- Query: k3l.Config.Device.X.EnabledChannelCount
- SNMP: 1.3.1.X.3.0
- MIB: KHOMP-MIB::k3lDeviceChannelCountEnabled.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais habilitados no dispositivo
Quantidade de grupos no dispositivo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de grupos no dispositivo
Quantidade de chamadas entrantes
- Tipo de requisição:
- SNMP: KHOMP-MIB::k3lDeviceStatsIncoming.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas entrantes
Quantidade de chamadas saintes
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceStatsOutgoing.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas saintes
Quantidade de chamadas saintes completadas
- Tipo de requisição:
- SNMP: KHOMP-MIB::k3lDeviceOutgoingCompleted.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas saintes completadas
Quantidade de erros em chamadas saintes
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceOutgoingError.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas saintes
Quantidade de chamadas que sofreram desconexão remota
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceRemoteDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de chamadas que sofreram desconexão remota
Quantidade de erros que sofreram desconexão local
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLocalDisconnect.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros que sofreram desconexão local
Quantidade de erros em chamadas ocupadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailBusy.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas ocupadas
Quantidade de erros em chamadas sem resposta
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailNoAnswer.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas sem resposta
Quantidade de erros em chamadas rejeitadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailRejected.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas rejeitadas
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
- Descrição: Quantidade de erros em chamadas cujo numero de destino mudou
Quantidade de erros em chamadas de numero invalido
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailInvalidNumber.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas de numero invalido
Quantidade de erros em chamadas fora de serviço
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailOutOfService.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas fora de serviço
Quantidade de erros devido a congestionamento na linha
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailCongestion.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros devido a congestionamento na linha
Quantidade de erros devido a falha na rede
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailNetworkFailure.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros devido a falha na rede
Quantidade de erros em chamadas (outros)
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceCallFailOther.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de erros em chamadas (outros)
Quantidade de canais consolidados por dispositivos
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCount
- Retorno: int
- Descrição: Quantidade de canais consolidados por dispositivos
Quantidade consolidada de canais habilitados por dispositivos
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountEnabled
- Retorno: int
- Descrição: Quantidade consolidada de canais habilitados por dispositivos
Quantidade consolidada de canais disponiveis por dispositivos
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountIdle
- Retorno: int
- Descrição: Quantidade consolidada de canais disponiveis por dispositivos
Quantidade consolidada de falha de canais por dispositivos
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountFail
- Retorno: int
- Descrição: Quantidade consolidada de falha de canais por dispositivos
Quantidade consolidada de canais ocupados por dispositivos
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lConsolidatedDevicesChannelCountBusy
- Retorno: int
- Descrição: Quantidade consolidada de canais ocupados por dispositivos
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
- Descrição: Quantidade de canais do link
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
- Descrição: Quantidade de canais habilitados no link
Quantidade de canais disponíveis no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountIdle.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais disponíveis no link
Quantidade de canais com falha no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountFail.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais com falha no link
Quantidade de canais ocupados no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkChannelCountBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de canais ocupados no 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
- Descrição: Quantidade de chamadas entrantes no link
Quantidade de chamadas saintes no link
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkStatsOutgoing.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de chamadas saintes no link
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
- Descrição: Quantidade de chamadas saintes completadas no link
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
- Descrição: Quantidade de erros em chamadas saintes no link
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
- Descrição: Quantidade de chamadas no link que sofreram desconexão remota
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
- Descrição: Quantidade de erros no link que sofreram desconexão local
Quantidade de erros em chamadas ocupadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas ocupadas
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
- Descrição: Quantidade de erros em chamadas sem resposta
Quantidade de erros em chamadas rejeitadas
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailRejected.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas rejeitadas
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
- Descrição: Quantidade de erros em chamadas cujo numero de destino mudou
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
- Descrição: Quantidade de erros em chamadas de numero invalido
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
- Descrição: Quantidade de erros em chamadas fora de serviço
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
- Descrição: Quantidade de erros devido a congestionamento na linha
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
- Descrição: Quantidade de erros devido a falha na rede
Quantidade de erros em chamadas (outros)
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCallFailOther.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Quantidade de erros em chamadas (outros)
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)
- Descrição: Modelo do dispositivo
Quantidade de canais VoIP do dispositivo
- Tipo de requisição:
- QUERY: k3l.Config.Device.X.VoIPChannelCount
- SNMP Legado: 1.3.1.X.12.0
- MIB: KHOMP-MIB::k3lDeviceSipChannelCount.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Quantidade de canais VoIP do dispositivo
Número Serial do dispositivo
- Tipos de requisição:
- QUERY: k3l.Config.Device.X.SerialNumber
- SNMP Legado: 1.3.1.X.16.0
- MIB: KHOMP-MIB::k3lDeviceSerial.X
- Parâmetros: X = ID na K3L
- Retorno: int
- Descrição: Número Serial do dispositivo
- NOTA: a MIB não suporta snmpget com X = ID. Deve-se usar snmpgetnext com X=serial ou snmpwalk para essa query
Sinalização do link
- Tipos de requisição:
- QUERY: k3l.Config.Link.X.Y.Signaling
- SNMP Legado: 1.3.2.X.Y.1.0
- MIB: KHOMP-MIB::k3lDeviceLinkSignaling.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int (KSignaling)
- Descrição: Sinalização do link
Nome atribuído ao link na configuração
- Tipos de requisição:
- QUERY: k3l.Config.Link.X.Y.Name
- SNMP Legado: 1.3.2.X.Y.7.0
- MIB: KHOMP-MIB::k3lDeviceLinkDescr.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: string
- Descrição: Nome atribuído ao link na configuração
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:
- QUERY: k3l.Config.Link.X.Y.OperatingMode
- SNMP Legado: 1.3.2.X.Y.8.0
- MIB: KHOMP-MIB::k3lDeviceLinkOperatingMode.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: string
- Descrição: Retorna 'E1' ou 'T1' para indicar o modo de operação do link
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:
- QUERY: k3l.Config.Link.X.Y.ReceivingClock
- SNMP Legado: 1.3.2.X.Y.9.0
- MIB: KHOMP-MIB::k3lDeviceLinkReceivingClock.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: bool
- Descrição: Indica se o link está recebendo a sincronização
Sinalização do canal
- Tipos de requisição:
- QUERY: k3l.Config.Channel.X.Y.Signaling
- SNMP Legado: 1.3.3.X.Y.1.0
- MIB: KHOMP-MIB::k3lDeviceChannelSignaling.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KSignaling)
- Descrição: Sinalização do canal
Versão da API
- Tipos de requisição:
- QUERY: k3l.Config.Api.StrVersion
- SNMP Legado: 1.3.5.7.0
- MIB: KHOMP-MIB::k3lVersionString.0
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Versão da API
País do padrão de troca de MFC utilizado pelo R2
- Tipos de requisição:
- QUERY: k3l.Config.Api.R2Country
- SNMP Legado: 1.3.5.8.0
- MIB: KHOMP-MIB::k3lConfigurationR2Country.0
- Parâmetros: Nenhum
- Retorno: int (KR2Country)
- Descrição: País do padrão de troca de MFC utilizado pelo R2
Nome da EBS Modular
Este recurso está disponível a partir da versão: 3.1.
|
- Tipos de requisição:
- QUERY: k3l.Config.EBS.X.String
- SNMP Legado: 1.3.6.X.1.0
- MIB: KHOMP-MIB::k3lDeviceDescr.X
- Parâmetros: X = Serial
- Retorno: string
- Descrição: Nome da EBS Modular
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:
- QUERY: k3l.Config.EBS.X.GSMChannels
- SNMP Legado: 1.3.6.X.2.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelCount.X
- Parâmetros: X = Serial
- Retorno: int,int,...,int
- Descrição: Números dos canais GSM presentes no EBS Modular
Endereço IP do EBS
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- QUERY: k3l.Config.EBS.X.IP
- SNMP Legado: 1.3.6.X.3.0
- MIB: KHOMP-MIB::k3lDeviceEbsIP.X
- Parâmetros: X = Serial
- Retorno: string
- Descrição: Endereço IP do EBS
Índice do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupIndex.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Índice do grupo
Tipo do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupType.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Tipo do grupo
Índice do primeiro canal do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupFirstChannel.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Índice do primeiro canal do grupo
Quantidade de canais do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelCount.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais do grupo
Quantidade de canais disponiveis do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelIdle.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais disponiveis do grupo
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
- Descrição: Quantidade de canais em falha do grupo
Quantidade de canais ocupados do grupo
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceChannelGroupChannelBusy.X.Y
- Parâmetros: X = Serial, Y = Grupo
- Retorno: int
- Descrição: Quantidade de canais ocupados do grupo
Estado
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
- Descrição: Estado simplificado do link (UP,DOWN)
Estado do link
- Tipo de requisição:
- QUERY: k3l.Status.Link.X.Y.E1
- SNMP Legado: 1.4.1.X.Y.1.0
- MIB: KHOMP-MIB::k3lDeviceLinkAlarm.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int (KE1Status)
- Descrição: Estado do link
Estado do link
- Tipo de requisição:
- QUERY: k3l.Status.Link.X.Y.Z.E1
- SNMP Legado: 1.4.1.X.Y.Z.1.0
- MIB: KHOMP-MIB::k3lDeviceLinkAlarm.X.Y
- Parâmetros: X = Serial, Y = Link, Z = Ignorado
- Retorno: int (KE1Status)
- Descrição: Estado do link
Estado do canal
- Tipo de requisição:
- QUERY: k3l.Status.Link.X.Y.Z.Channels
- SNMP Legado: 1.4.1.X.Y.Z.2.0
- MIB: KHOMP-MIB::k3lDeviceE1ChannelStatus.X.Z
- Parâmetros: X = Serial, Y = Link, Z = Canal
- Retorno: int (KE1ChannelStatus)
- Descrição: Estado do canal
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
- 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.
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:
- QUERY: k3l.Status.Link.X.Y.HI
- SNMP Legado: 1.4.1.X.Y.3.0
- MIB: KHOMP-MIB::k3lDeviceHILinkAlarm.X.Y
- 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.
Estado da chamada
- Tipo de requisição:
- QUERY: k3l.Status.Channel.X.Y.CallStatus
- SNMP Legado: 1.4.2.X.Y.1.0
- MIB: KHOMP-MIB::k3lDeviceChannelCallStatus.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KCallStatus)
- Descrição: Estado da chamada
Estado do áudio no canal
- Tipo de requisição:
- QUERY: k3l.Status.Channel.X.Y.AudioStatus
- SNMP Legado: 1.4.2.X.Y.2.0
- MIB: KHOMP-MIB::k3lDeviceChannelAudioStatus.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KDetectionTone)
- Descrição: Estado do áudio no canal
Informações adicionais sobre o estado do canal
- Tipo de requisição:
- QUERY: k3l.Status.Channel.X.Y.AddInfo
- SNMP Legado: 1.4.2.X.Y.3.0
- MIB: 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.
Recursos habilitados
- Tipo de requisição:
- QUERY: k3l.Status.Channel.X.Y.EnabledFeatures
- SNMP Legado: 1.4.2.X.Y.4.0
- MIB: KHOMP-MIB::k3lDeviceChannelEnabledFeatures.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int (KChannelFeatures)
- Descrição: Recursos habilitados
Total de canais em falha
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.TotalFail
- SNMP Legado: 1.4.2.X.5.0
- MIB: KHOMP-MIB::k3lDeviceCountFail.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em falha
Total de canais em espera
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.TotalIdle
- SNMP Legado: 1.4.2.X.6.0
- MIB: KHOMP-MIB::k3lDeviceCountIdle.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em espera
Total de canais em chamada
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.TotalCall
- SNMP Legado: 1.4.2.X.7.0
- MIB: KHOMP-MIB::k3lDeviceCountBusy.X
- Parâmetros: X = Serial
- Retorno: int
- Descrição: Total de canais em chamada
Total de canais em falha no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCountFail.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em falha no link
Total de canais em espera no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCountIdle.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em espera no link
Total de canais em chamada no link
Este recurso está disponível a partir da versão: 3.3.
|
- Tipo de requisição:
- MIB: KHOMP-MIB::k3lDeviceLinkCountBusy.X.Y
- Parâmetros: X = Serial, Y = Link
- Retorno: int
- Descrição: Total de canais em chamada no link
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.DialNumber
- SNMP Legado: 1.4.2.X.Y.8.0
- MIB: KHOMP-MIB::k3lDeviceChannelDestinationAddress.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
- Descrição: Número discado na ligação corrente
(Observação: k3l.Status.Channel.X.Y.DestinationAddress também é uma query válida)
Duração da ligação corrente em milissegundos
Este recurso está disponível a partir da versão: 3.2.
|
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.Y.CallDuration
- SNMP Legado: 1.4.2.X.9.0
- MIB: KHOMP-MIB::k3lDeviceChannelCallDuration.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
- Descrição: Duração da ligação corrente em milissegundos
Indica se o canal está gravando
Este recurso está disponível a partir da versão: 3.2.
|
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.Y.RecordingStatus
- SNMP Legado: 1.4.2.X.10.0
- MIB: KHOMP-MIB::k3lDeviceChannelRecording.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: bool
- Descrição: Indica se o canal está gravando
Média da duração das ligações do canal, em milissegundos
Este recurso está disponível a partir da versão: 3.3.
|
- Tipos de requisição:
- QUERY: k3l.Status.Channel.X.Y.AverageCallTime
- SNMP Legado: 1.4.2.X.11.0
- MIB: KHOMP-MIB::k3lDeviceChannelAverageCallTime.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: int
- Descrição: Média da duração das ligações do canal, em segundos
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:
- QUERY: k3l.Status.Channel.X.Y.OriginAddress
- SNMP Legado: 1.4.2.X.Y.12.0
- MIB: KHOMP-MIB::k3lDeviceChannelOriginAddress.X.Y
- Parâmetros: X = Serial, Y = Canal
- Retorno: string
- Descrição: Número de origem na ligação corrente
Contadores de erros do link
- Tipos de requisição:
- QUERY: k3l.Status.LinkErrorCounter.X.Y
- SNMP Legado: 1.4.4.X.Y.0
- MIB: 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.
Nível de sinal
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.SignalStrength.Z
- SNMP Legado: 1.4.5.X.Y.1.Z.0
- MIB: 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
Taxa de erros
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.ErrorRate.Z
- SNMP Legado: 1.4.5.X.Y.2.Z.0
- MIB: 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
Estado do registro
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.RegistryStatus.Z
- SNMP Legado: 1.4.5.X.Y.3.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelRegistryStatus.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int (KGsmRegistryStatus)
- Descrição: Estado do registro
Nome da operadora
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.OperName.Z
- SNMP Legado: 1.4.5.X.Y.4.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelOperName.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Nome da operadora
Número de SMS não lidos
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.UnreadSmsCount.Z
- SNMP Legado: 1.4.5.X.Y.5.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelUnreadSmsMessages.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Descrição: Número de SMS não lidos
Recursos habilitados
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.EnabledFeatures.Z
- SNMP Legado: 1.4.5.X.Y.6.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelEnabledFeatures.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Descrição: Recursos habilitados
Retorna o número IMEI
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.IMEI.Z
- SNMP Legado: 1.4.5.X.Y.7.Z.0
- MIB: 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).
SIM card atualmente selecionado
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.SIM.Z
- SNMP Legado: 1.4.5.X.Y.8.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelSim.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: char
- Descrição: SIM card atualmente selecionado.
Estado da chamada Z no canal Y
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.CallStatus.Z
- SNMP Legado: 1.4.5.X.Y.9.Z.0
- MIB: 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
Retorna o número IMSI
Este recurso está disponível a partir da versão: 3.2.4.
|
- Tipos de requisição:
- QUERY: k3l.Status.GSMChannel.X.Y.IMSI.Z
- SNMP Legado: 1.4.5.X.Y.10.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelImsi.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número 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:
- QUERY: k3l.Status.GSMChannel.X.Y.ICCID.Z
- SNMP Legado: 1.4.5.X.Y.11.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelIccid.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número 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:
- QUERY: k3l.Status.GSMChannel.X.Y.MSISDN.Z
- SNMP Legado: 1.4.5.X.Y.12.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelMsisdn.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: string
- Descrição: Retorna o número 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:
- QUERY: k3l.Status.GSMChannel.X.Y.CallWaiting.Z
- SNMP Legado: 1.4.5.X.Y.13.Z.0
- MIB: KHOMP-MIB::k3lDeviceGsmChannelCallWaiting.X.Y
- Parâmetros: X = Serial, Y = Canal, Z = Ignorado
- Retorno: int
- Descrição: Retorna o estado do recurso de Call Waiting (0=disabled 1=enabled 2=unknown)
Estado
- Tipos de requisição:
- QUERY: k3l.Status.Connected.X
- MIB: 1.4.6.X.0
- Parâmetros: X = Serial
- Retorno: bool
- Descrição: Estado (1=conectado, 0=desconectado)
Estatística
Estatísticas do canal
- Tipos de requisição:
- QUERY: k3l.ChannelStats.X.Y
- SNMP Legado: 1.5.X.Y.0
- MIB: 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
Perfil
Endereço local utilizado para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: 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.
Porta local utilizada para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: 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.
Tipo de transporte (UDP ou TCP) utilizado para preencher as mensagens SIP.
- Tipo de requisição:
- QUERY: 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.
Endereço local utilizado para a troca de áudio RTP
- Tipo de requisição:
- QUERY: 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.
"Address of Record" utilizado no registro
- Tipo de requisição:
- QUERY: 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.
Parâmetro "username" utilizado no campo "Authorization".
- Tipo de requisição:
- QUERY: 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".
Parâmetro "realm" utilizado no campo "Authorization"
- Tipo de requisição:
- QUERY: 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".
Endereço do servidor onde será feito o registro.
- Tipo de requisição:
- QUERY: 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.
Porta do servidor onde será feito o registro
- Tipo de requisição:
- QUERY: 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.
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
- 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.
Porta do proxy por onde a mensagem deve passar antes de chegar no servidor
- Tipo de requisição:
- QUERY: 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.
Indica se o profile está registrado ou não em um servidor
- Tipo de requisição:
- QUERY: 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.
Canal
Número de transações.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.TransactionCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente e servidora.
Número de transações cliente.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente.
Número de transações servidora.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações servidora.
Número de transações cliente com falha.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailureCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente com falha.
Número de transações servidora com falha.
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailureCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações servidora com falha.
Número de transações cliente com falha (código de erro 4xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure4xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente com falha (código de erro 4xx).
Número de transações servidora com falha (código de erro 4xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure4xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações servidora com falha (código de erro 4xx).
Número de transações cliente com falha (código de erro 5xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure5xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente com falha (código de erro 5xx).
Número de transações servidora com falha (código de erro 5xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure5xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações servidora com falha (código de erro 5xx).
Número de transações cliente com falha (código de erro 6xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ClientTransactionFailure6xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações cliente com falha (código de erro 6xx).
Número de transações servidora com falha (código de erro 6xx).
- Tipo de requisição:
- QUERY: voip.GW.Channel.X.ServerTransactionFailure6xxCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de transações servidora com falha (código de erro 6xx).
RTP
Número de sequência do último pacote RTP enviado
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.LastSequenceNumber
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de sequência do último pacote RTP enviado.
Número de pacotes RTP enviados
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.PacketCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de pacotes RTP enviados.
Número total de octetos RTP enviados
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.OctetCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número total de octetos RTP enviados.
Número de pacotes RTP enviados perdidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Transmit.PacketLost
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de pacotes RTP enviados perdidos.
Número de sequência do primeiro pacote RTP recebido
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.InitialSequenceNumber
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de sequência do primeiro pacote RTP recebido.
Número de sequência do último pacote RTP recebido
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.LastSequenceNumber
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de sequência do último pacote RTP recebido.
Número de pacotes RTP recebidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.PacketCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Número de pacotes RTP recebidos.
Quantidade total de pacotes entrantes perdidos
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.DroppedCount
- Parâmetros: X = Canal SIP
- Retorno: int
- Descrição: Quantidade total de pacotes entrantes perdidos.
Quantidade de pacotes entrantes perdidos em sequência
- Tipo de requisição:
- QUERY: voip.Media.RTPStatus.X.Receive.LastDroppedCount
- Parâmetros: X = Canal SIP
- 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
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
- Descrição: Retorna uma lista com os nomes dos grupos de circuitos presentes no arquivo de configuração.
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
- Descrição: Retorna o point code de origem (originating point code).
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
- Descrição: Retorna o point code de destino (destination point code).
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
- Descrição: Retorna o código de identificação do circuito (circuit identification code) inicial.
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)
- Descrição: Indica se representa um grupo de sinalização passiva.
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
- Descrição: Retorna o número de circuitos.
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
- Descrição: Retorna o mapa de timeslot.
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
- Descrição: Retorna o endereço IP onde está localizado o grupo de circuito.
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
- Descrição: Retorna o número de série da placa, localizada na máquina informada pelo campo address.
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
- Descrição: Retorna o número do link, localizado na máquina e placa informadas pelos campos address e device.
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)
- 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).
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)
- Descrição: Indica se o link da placa está ativo (informado pelo HDLC).
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)
- Descrição: Indica se algum link mtp3 está ativo para o grupo de circuito (informado pelo MTP3).
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
- 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.
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
- 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.
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
- Descrição: Retorna uma lista com os valores dos códigos de identificação do circuito (circuit identification codes) do grupo de circuito.
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
- Descrição: Retorna o valor do identificador global único do circuito (utilizado internamente).
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
- 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.
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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna o número de circuitos licenciados.
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)
- Descrição: Indica se o circuito com identificador global de número X está licenciado.
MTP3
Retorna uma lista com os nomes dos linksets presentes no arquivo de configuração
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes dos linksets presentes no arquivo de configuração.
Retorna o identificador do linkset
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.id
- Parâmetros: X = Nome do linkset
- Retorno: int
- Descrição: Retorna o identificador do linkset.
Retorna o point code de origem
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.originPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o point code de origem (origin point code).
Retorna o point code adjacente
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.adjacentPointCode
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o point code adjacente (adjacent point code).
Retorna o indicador de rede
- Tipo de requisição:
- QUERY: ss7.mtp3.linkSet.X.networkIndicator
- Parâmetros: X = Nome do linkset
- Retorno: string
- Descrição: Retorna o indicador de rede (network indicator).
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)
- Descrição: Indica se o linkset está ativo.
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
- Descrição: Retorna uma lista com os nomes dos links pertencentes ao linkset.
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
- Descrição: Retorna o nome do link MTP2.
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
- Descrição: Retorna o SLC.
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
- Descrição: Retorna o valor do timer Q.707 T1 (em milissegundos).
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
- Descrição: Retorna o valor do timer Q.707 T2 (em milissegundos).
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
- Descrição: Retorna o valor do timer Q.704 T17 (em milissegundos).
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)
- Descrição: Indica se o link está disponível.
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)
- Descrição: Indica se o link está em serviço.
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)
- Descrição: Indica se a ativação está em progresso.
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)
- Descrição: Indica se o link está ativado.
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)
- Descrição: Indica se o link está bloqueado.
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)
- Descrição: Indica se o link está no estado inhibited.
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)
- Descrição: Indica se o link está no estado remote processor outage.
Retorna uma lista com os nomes das rotas existentes
- Tipo de requisição:
- Parâmetros: Nenhum
- Retorno: string
- Descrição: Retorna uma lista com os nomes das rotas existentes.
Retorna o point code cadastrado
- Tipo de requisição:
- QUERY: ss7.mtp3.route.X.pointCode
- Parâmetros: X = Nome da rota
- Retorno: string
- Descrição: Retorna o point code cadastrado.
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
- Descrição: Retorna uma lista com os nomes dos linksets da rota X.
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
- Descrição: Retorna uma lista com os nomes dos links MTP2 presentes no arquivo de configuração.
Retorna o endereço
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.address
- Parâmetros: X = Nome do link
- Retorno: string
- Descrição: Retorna o endereço.
Retorna o dispositivo
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.device
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o dispositivo.
Retorna o link
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.link
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o link.
Retorna o timeslot
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.timeslot
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna o timeslot.
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)
- Descrição: Indica se o link é passivo.
Retorna o valor do timer T1
- Tipo de requisição:
- QUERY: ss7.mtp2.link.X.T1
- Parâmetros: X = Nome do link
- Retorno: int
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna 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
- Descrição: Retorna uma lista com os nomes dos point codes presentes no arquivo de configuração.
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
- Descrição: Retorna o primeiro campo do point code.
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
- Descrição: Retorna o segundo campo do point code.
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
- Descrição: Retorna o último campo do point code.
Comandos Disponíveis
Reinicia o link
- Tipo de requisição:
- Parâmetros: X = Serial, Y = Link
- Descrição: Reinicia o link
Zera os contadores de erro do link
- Tipo de requisição:
- CMD: k3l.ClearLinkErrorCounter.X.Y
- Parâmetros: X = Serial, Y = Link
- Descrição: Zera os contadores de erro do link
Bloqueia todos os canais do link
- Tipo de requisição:
- Parâmetros: X = Serial, Y = Link
- Descrição: Bloqueia todos os canais do 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
- Descrição: Reinicia o modem
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
- Descrição: Zera as estatísticas do 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).