[comment]: # ({cd91b3fe-cd91b3fe})
# script.get

[comment]: # ({/cd91b3fe-cd91b3fe})

[comment]: # ({51a19337-f68e1936})
### Description

`integer/array script.get(object parameters)`

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

[comment]: # ({/51a19337-f68e1936})

[comment]: # ({fa9f219f-99713b5e})
### 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|
|----------|----|-----------|
|groupids|string/array|Renvoie uniquement les scripts pouvant être exécutés sur les groupes hôtes donnés.|
|hostids|string/array|Renvoie uniquement les scripts pouvant être exécutés sur les hôtes donnés.|
|scriptids|string/array|Renvoie uniquement les scripts avec les identifiants donnés.|
|usrgrpids|string/array|Renvoie uniquement les scripts pouvant être exécutés par les utilisateurs des groupes d'utilisateurs donnés.|
|selectGroups|query|Renvoie les groupes d'hôtes sur lesquels le script peut être exécuté dans la propriété `groups`.|
|selectHosts|query|Renvoie les hôtes sur lesquels le script peut être exécuté dans la propriété `hosts`.|
|sortfield|string/array|Trie le résultat en fonction des propriétés données.<br><br>Valeurs possibles : `scriptid` et `name`.|
|countOutput|boolean|Ces paramètres, communs à toutes les méthodes "get", sont décrits dans les [commentaires de référence](/fr/manual/api/reference_commentary#Parametres_communs_de_la_methode_get).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/fa9f219f-99713b5e})

[comment]: # ({36e7b1e2-7223bab1})
### 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é.

[comment]: # ({/36e7b1e2-7223bab1})

[comment]: # ({88e43968-b41637d2})
### Exemples

[comment]: # ({/88e43968-b41637d2})

[comment]: # ({9f64b207-46654cf2})
#### Récupération de tous les scripts

Récupérer tous les scripts configurés.

Requête :

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "script.get",
    "params": {
        "output": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Réponse :

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [    
        {
            "scriptid": "1",
            "name": "Ping",
            "command": "/bin/ping -c 3 {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "0",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1"
        },
        {
            "scriptid": "2",
            "name": "Traceroute",
            "command": "/usr/bin/traceroute {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "0",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1"
        },
        {
            "scriptid": "3",
            "name": "Detect operating system",
            "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "7",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1"
        }
    ],
    "id": 1
}
```

[comment]: # ({/9f64b207-46654cf2})

[comment]: # ({d37a4caf-b0b740ec})
### Voir également

-   [Hôte](/fr/manual/api/reference/host/object#hote)
-   [Groupe
    d'Hôte](/fr/manual/api/reference/hostgroup/object#groupe_d_hote)

[comment]: # ({/d37a4caf-b0b740ec})

[comment]: # ({d19a9813-565a7d82})
### Source

CScript::get() dans
*frontends/php/include/classes/api/services/CScript.php*.

[comment]: # ({/d19a9813-565a7d82})