A classe SNMP

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

Introdução

Representa uma sessão SNMP.

Resumo da classe

class SNMP {
/* Constantes */
public const int VERSION_1;
public const int VERSION_2c;
public const int VERSION_2C;
public const int VERSION_3;
public const int ERRNO_NOERROR;
public const int ERRNO_ANY;
public const int ERRNO_GENERIC;
public const int ERRNO_TIMEOUT;
public const int ERRNO_ERROR_IN_REPLY;
public const int ERRNO_OID_NOT_INCREASING;
public const int ERRNO_OID_PARSING_ERROR;
public const int ERRNO_MULTIPLE_SET_QUERIES;
/* Propriedades */
public readonly array $info;
public ?int $max_oids;
public int $valueretrieval;
public bool $quick_print;
public bool $enum_print;
public int $oid_output_format;
public bool $oid_increasing_check;
public int $exceptions_enabled;
/* Métodos */
public __construct(
    int $version,
    string $hostname,
    string $community,
    int $timeout = -1,
    int $retries = -1
)
public close(): bool
public get(array|string $objectId, bool $preserveKeys = false): mixed
public getErrno(): int
public getError(): string
public getnext(array|string $objectId): mixed
public set(array|string $objectId, array|string $type, array|string $value): bool
public setSecurity(
    string $securityLevel,
    string $authProtocol = "",
    string $authPassphrase = "",
    string $privacyProtocol = "",
    string $privacyPassphrase = "",
    string $contextName = "",
    string $contextEngineId = ""
): bool
public walk(
    array|string $objectId,
    bool $suffixAsKey = false,
    int $maxRepetitions = -1,
    int $nonRepeaters = -1
): array|false
}

Propriedades

max_oids
OID máximo por solicitação GET/SET/GETBULK
valueretrieval
Controla o método como os valores SNMP serão retornados
SNMP_VALUE_LIBRARYOs valores de retorno serão aqueles retornados pela biblioteca Net-SNMP.
SNMP_VALUE_PLAINOs valores de retorno serão o valor simples sem as informações do tipo SNMP.
SNMP_VALUE_OBJECT Os valores de retorno serão objetos com as propriedades "value" e "type", onde esta última é uma das constantes SNMP_OCTET_STR, SNMP_COUNTER etc. A forma como "value" é retornado depende de qual das seguintes opções está definida: SNMP_VALUE_LIBRARY ou SNMP_VALUE_PLAIN.
quick_print
Valor de quick_print na biblioteca NET-SNMP Define o valor de quick_print na biblioteca NET-SNMP. Quando este parâmetro estiver definido (1), a biblioteca SNMP retornará valores de 'impressão rápida'. Isso significa que apenas o valor será impresso. Quando quick_print não estiver habilitado (padrão), a biblioteca NET-SNMP imprime informações extras, incluindo o tipo do valor (por exemplo, Endereço IP ou OID). Além disso, se quick_print não estiver habilitado, a biblioteca imprime valores hexadecimais adicionais para todas as strings de três caracteres ou menos.
enum_print
Controla a maneira como os valores de enumeração são impressos Os parâmetros alternam se as funções walk/get etc. devem procurar automaticamente valores de enumeração no MIB e retorná-los junto com sua string legível.
oid_output_format
Controla o formato de saída OID
Representação do OID .1.3.6.1.2.1.1.3.0 para vários valores de oid_output_format
SNMP_OID_OUTPUT_FULL.iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.sysUpTimeInstance
SNMP_OID_OUTPUT_NUMERIC.1.3.6.1.2.1.1.3.0
SNMP_OID_OUTPUT_MODULEDISMAN-EVENT-MIB::sysUpTimeInstance
SNMP_OID_OUTPUT_SUFFIXsysUpTimeInstance
SNMP_OID_OUTPUT_UCDsystem.sysUpTime.sysUpTimeInstance
SNMP_OID_OUTPUT_NONEUndefined
oid_increasing_check
Controla a desativação da verificação para aumentar o OID enquanto caminha pela árvore OID Alguns agentes SNMP são conhecidos por retornar OIDs fora de ordem, mas conseguem completar a caminhada mesmo assim. Outros agentes retornam OIDs que estão fora de ordem e podem fazer com que SNMP::walk() entre em loop indefinidamente até que o limite de memória seja atingido. A biblioteca SNMP do PHP, por padrão, executa a verificação de aumento de OID e interrompe a caminhada na árvore de OIDs quando detecta um possível loop, emitindo um aviso sobre a presença de OIDs não crescentes. Defina oid_increasing_check como false para desabilitar esta verificação.
exceptions_enabled
Controla quais falhas gerarão uma exceção SNMPException em vez de avisos. Use constantes SNMP::ERRNO_* com OR binário. Por padrão, todas as exceções SNMP são desabilitadas.
info
Propriedade somente leitura com configuração de agente remoto: nome do host, porta, tempo limite padrão, contagem de tentativas padrão

Constantes predefinidas

SNMP Error Types

SNMP::ERRNO_NOERROR
Não ocorreu nenhum erro específico de SNMP.
SNMP::ERRNO_GENERIC
Ocorreu um erro genérico SNMP.
SNMP::ERRNO_TIMEOUT
A solicitação ao agente SNMP atingiu o tempo limite.
SNMP::ERRNO_ERROR_IN_REPLY
O agente SNMP retornou um erro na resposta.
SNMP::ERRNO_OID_NOT_INCREASING
O agente SNMP enfrentou um ciclo de OID reportando OID não crescente durante a execução do comando (BULK)WALK. Isso indica um agente SNMP remoto falso.
SNMP::ERRNO_OID_PARSING_ERROR
A biblioteca falhou ao analisar o OID (e/ou tipo para o comando SET). Nenhuma consulta foi realizada.
SNMP::ERRNO_MULTIPLE_SET_QUERIES
A biblioteca utilizará múltiplas consultas para a operação SET solicitada. Isso significa que a operação será realizada de forma não transacional e o segundo bloco ou os blocos subsequentes poderão falhar caso ocorra uma falha de tipo ou valor.
SNMP::ERRNO_ANY
Todos os códigos SNMP::ERRNO_* são combinados com OR binário.

Índice