Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

valuemap.get

Description

integer/array valuemap.get(object parameters)

La méthode permet de récupérer des correspondances de valeurs en fonction des paramètres donnés.

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.

Paramètres

(objet) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
valuemapids string/array Renvoie uniquement les tables de correspondances de valeurs avec les ID donnés.
selectMappings query Renvoie les correspondances de valeurs actuelle dans la propriété mappings.

Supporte count.
sortfield string/array Trie le résultat selon les propriétés données.

Les valeurs possibles sont : valuemapid, name.
countOutput boolean Ces paramètres, communs à toutes les méthodes get, sont décrits dans les commentaires de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des cartes de valeurs

Récupérez toutes les cartes de valeurs configurées.

Requête :

{
           "jsonrpc": "2.0",
           "method": "valuemap.get",
           "params": {
               "output": "extend"
           },
           "auth": "57562fd409b3b3b9a4d916d45207bbcb",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "valuemapid": "4",
                   "name": "APC Battery Replacement Status"
               },
               {
                   "valuemapid": "5",
                   "name": "APC Battery Status"
               },
               {
                   "valuemapid": "7",
                   "name": "Dell Open Manage System Status"
               }
           ],
           "id": 1
       }

Récupérez une carte de valeurs avec ses correspondances.

Requête :

{
           "jsonrpc": "2.0",
           "method": "valuemap.get",
           "params": {
               "output": "extend",
               "selectMappings": "extend",
               "valuemapids": ["4"]
           },
           "auth": "57562fd409b3b3b9a4d916d45207bbcb",
           "id": 1
       }

Réponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "valuemapid": "4",
                   "name": "APC Battery Replacement Status",
                   "mappings": [
                       {
                           "type": "0",
                           "value": "1",
                           "newvalue": "unknown"
                       },
                       {
                           "type": "0",
                           "value": "2",
                           "newvalue": "notInstalled"
                       },
                       {
                           "type": "0",
                           "value": "3",
                           "newvalue": "ok"
                       },
                       {
                           "type": "0",
                           "value": "4",
                           "newvalue": "failed"
                       },
                       {
                           "type": "0",
                           "value": "5",
                           "newvalue": "highTemperature"
                       },
                       {
                           "type": "0",
                           "value": "6",
                           "newvalue": "replaceImmediately"
                       },
                       {
                           "type": "0",
                           "value": "7",
                           "newvalue": "lowCapacity"
                       }
                   ]
               }
           ],
           "id": 1
       }

Source

CValueMap::get() dans ui/include/classes/api/services/CValueMap.php.