snmpset

    (PHP 4, PHP 5, PHP 7, PHP 8)

    snmpset — Définit la valeur d'un objet SNMP

    Description

    function snmpset(
        string $hostname,
        string $community,
        array|string $object_id,
        array|string $type,
        array|string $value,
        int $timeout = -1,
        int $retries = -1
    ): bool

    snmpset() sert à définir la valeur de l'objet SNMP spécifié par object_id.

    Liste de paramètres

    hostname
    Le nom d'hôte de l'agent SNMP (serveur).
    community
    La communauté d'écriture.
    object_id
    L'identifiant de l'objet SNMP.
    type
    Le MIB définit le type de chaque identifiant d'objets. Il doit être spécifié sous la forme d'un simple caractère depuis la liste suivante.
    types
    =Le type est récupéré depuis le MIB
    iINTEGER
    uINTEGER
    sSTRING
    xHEX STRING
    dDECIMAL STRING
    nNULLOBJ
    oOBJID
    tTIMETICKS
    aIPADDRESS
    bBITS
    Si la constante OPAQUE_SPECIAL_TYPES a été définie lors de la compilation de la bibliothèque SNMP, les caractères suivants seront également disponibles :
    types
    Uint64 non-signé
    Iint64 signé
    Ffloat
    Ddouble
    La plupart de ces valeurs utilise le type ASN.1 correspondant. 's', 'x', 'd' et 'b' sont toutes des façons différentes de spécifier la valeur OCTET STRING et le type non-signé 'u' est également utilisé pour gérer les valeurs Gauge32. Si les fichiers MIB sont chargés dans l'arbre MIB avec "snmp_read_mib" ou en les spécifiant dans la configuration de libsnmp, '=' pourra être utilisé comme paramètre de type pour tous les identifiants d'objets, vu que le type peut automatiquement être lu depuis le MIB. Notez qu'il y a 2 façons de définir une variable de type BITS like i.e. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
    • En utilisant le type "b" et une liste d'octets. Cette méthode n'est pas recommandée vu que la requête GET pour un même OID retournera i.e. 0xF8.
    • En utilisant le type "x" et un nombre hexadécimal mais sans(!) le préfixe usuel "0x".
    Reportez-vous à la section sur les exemples pour plus de détails.
    value
    La nouvelle valeur.
    timeout
    Le nombre de microsecondes depuis le premier timeout.
    retries
    Le nombre d'essais avant d'atteindre le délai maximal d'attente.

    Valeurs de retour

    Cette fonction retourne true en cas de succès ou false si une erreur survient.

    Si l'hôte SNMP rejette le type de données, une alerte de type E_WARNING comme "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." sera affiché. Si un OID inconnu ou invalide est spécifié, le contenu de l'alerte sera probablement "Could not add variable".

    Historique

    Version Description
    8.5.0 Lance désormais une ValueError quand la longueur du nom d'hôte est supérieure ou égale à 128 octets, quand le port est négatif ou supérieur à 65535, ou quand les valeurs du délai d'expiration ou du nombre de tentatives sont inférieures à -1 ou trop grandes.

    Exemples

    Exemple #1 Exemple avec snmpset()

    <?php
  snmpset("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
?>

    Exemple #2 Exemple avec snmpset() pour configurer l'identifiant de l'objet SNMP BITS

    <?php
  snmpset("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
  snmpset("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
?>

    Voir aussi

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    0
    ch at lathspell dot de
    16 years ago
    Note that there are two ways to set a variable of the type BITS like e.g.: 
  SYNTAX        BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}

1. Using type "b" and a list of bit numbers like:
  snmpset('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
with the disadvantage that the success is not easily verifyable as an snmpget() for the same OID would return e.g. 0xF8.

2. Using type "x" and a hex number but without(!) the usual "0x" prefix:
  snmpset('FOO-MIB::bar.42', 'x', 'F0');
    up
    0
    deivis dot jakstas at gmail dot com
    19 years ago
    If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");
    up
    0
    slawrance at technologist dot com
    26 years ago
    The "type" parameter must be one of the following, depending on the type of variable to set on the SNMP host:

i    INTEGER
u    unsigned INTEGER
t    TIMETICKS
a    IPADDRESS
o    OBJID
s    STRING
x    HEX STRING
d    DECIMAL STRING
n    NULLOBJ
b    BITS

If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the
following are also valid:

U    unsigned int64
I    signed int64
F    float
D    double

As an example, using "i" would set an integer, and "s" would set a string.  If the SNMP host rejects the data type, you might get the following message: "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length."

If you specify an unknown or invalid OID, you might get a "Could not add variable" message.  When specifying an absolute OID (one that is already resolved) that is completely numeric, prepend it with a period.  For example, an OID that could enable/disable Ethernet ports on an Asante hub might be "1.3.6.1.2.1.22.1.3.1.1.3.6.4.0", but you would need to use ".1.3.6.1.2.1.22.1.3.1.1.3.6.4.0" in the OID parameter so that the SNMP library won't try to resolve an already resolved OID.  Friendly, unresolved OIDs do not need the period prepended, such as "system.SysContact.0"
    ＋add a note
    To Top