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

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

[comment]: # ({ce6433f5-96ec37bc})
### Descripció

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

El mètode permet recuperar scripts segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/ce6433f5-96ec37bc})

[comment]: # ({e8f097a4-c425a65a})
### Paràmetres

`(objet)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|groupids|string/array|Retorna només scripts que es poden executar als grups d'equips donats.|
|hostids|string/array|Retorna només scripts que es poden executar als equips donats.|
|scriptids|string/array|Retorna només scripts amb els ID donats.|
|usrgrpids|string/array|Retorna només scripts que poden ésser executats pels usuaris dels grups d'usuaris determinats.|
|selectHostGroups|query|Retorna una propietat [grups](/manual/api/reference/hostgroup/object) amb els grups d'equips on es pot executar l'script.|
|selectHosts|query|Retorna una propietat [equips](/manual/api/reference/host/object) amb els equips en què es pot executar l'script.|
|selectActions|query|Retorna una propietat [accions](/manual/api/reference/action/object) amb les accions a les quals està associat l'script.|
|sortfield|string/array|Ordena el resultat per les propietats donades.<br><br>Els valors possibles són: `scriptid` i `name`.|
|countOutput|boolean|Aquests paràmetres, comuns a tots els mètodes `get`, es descriuen als [comentaris de referència](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectGroups<br>(obsolet)|query|Aquest paràmetre és obsolet; si et plau, empra `selectHostGroups` en el seu lloc.<br>Retorna la propietat [grups](/manual/api/reference/templategroup/object) amb informació dels grups d'equips on pertany l'equip.|

[comment]: # ({/e8f097a4-c425a65a})

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

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

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

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

[comment]: # ({286dbf8b-6d428f32})
#### Recuperar tots els scripts

Recupera tots els scripts configurats.

[Petició](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.get",
    "params": {
        "output": "extend"
    },
    "id": 1
}
```

Resposta:

```json
{
    "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",
            "timeout": "30s",
            "parameters": []
        },
        {
            "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",
            "timeout": "30s",
            "parameters": []
        },
        {
            "scriptid": "3",
            "name": "Detectar sistema operatiu",
            "command": "sudo /usr/bin/nmap -O {HOST.CONN} 2>&1",
            "host_access": "2",
            "usrgrpid": "7",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "0",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": []
        },
        {
            "scriptid": "4",
            "name": "Webhook",
            "command": "try {\n var request = new HttpRequest(),\n response,\n data;\n\n request.addHeader('Content-Type: application/json');\n\n response = request.post('https://localhost/post', value);\n\n try {\n response = JSON.parse(response);\n }\n catch (error) {\n response = null;\n }\n\n if (request.getStatus() !== 200 || !('data' in response)) {\n throw 'Unexpected response.';\n }\n\n data = JSON.stringify(response.data);\n\n Zabbix.Log(3, '[Webhook Script] response data: ' + data);\n\n return data;\n}\ncatch (error) {\n Zabbix.Log(3, '[Webhook Script] script execution failed: ' + error);\n throw 'Execution failed: ' + error + '.';\n}",
            "host_access": "2",
            "usrgrpid": "7",
            "groupid": "0",
            "description": "",
            "confirmation": "",
            "type": "5",
            "execute_on": "1",
            "timeout": "30s",
            "parameters": [
                {
                    "name": "token",
                    "value": "{$WEBHOOK.TOKEN}"
                },
                {
                    "name": "host",
                    "value": "{HOST.HOST}"
                },
                {
                    "name": "v",
                    "value": "2.2"
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/286dbf8b-6d428f32})

[comment]: # ({b0b740ec-b0b740ec})
### Veieu també

- [Equip](/manual/api/reference/host/object#object_details)
- [Grup d'equips](/manual/api/reference/hostgroup/object#object_details)

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

[comment]: # ({90dfc753-90dfc753})
### Font

CScript::get() in *ui/include/classes/api/services/CScript.php*.

[comment]: # ({/90dfc753-90dfc753})