module.get

Description

integer/array module.get(object parameters)

La méthode permet de récupérer des modules selon les paramètres fournis.

Cette méthode est uniquement disponible pour le type d'utilisateur Super admin. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez Rôles utilisateur pour plus d'informations.
Si $ZBX_FEATURE_FLAGS['modules_config_enabled'] est défini sur false dans le fichier de configuration de l'interface (zabbix.conf.php), l'utilisateur ne sera pas autorisé à appeler cette méthode.

Paramètres

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

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

Paramètre Type Description
moduleids ID/array Retourner uniquement les modules avec les ID donnés.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : moduleid, relative_path.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs de retour

(integer/array) Renvoie 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 d’un module par ID

Récupérez toutes les données des modules « 1 », « 2 » et « 25 ».

Requête :

{
    "jsonrpc": "2.0",
    "method": "module.get",
    "params": {
        "output": "extend",
        "moduleids": [
            "1",
            "2",
            "25"
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "moduleid": "1",
            "id": "actionlog",
            "relative_path": "widgets/actionlog",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "2",
            "id": "clock",
            "relative_path": "widgets/clock",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "25",
            "id": "example",
            "relative_path": "modules/example_module",
            "status": "1",
            "config": []
        }
    ],
    "id": 1
}

Voir aussi

Source

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