[comment]: # translation:outdated

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

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

[comment]: # ({96ec37bc-96ec37bc})
### Описание

`integer/array script.get(параметры объекта)`

Метод позволяет получать скрипты по заданным параметрам.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/administration/user_roles).
:::

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

[comment]: # ({new-c425a65a})
### Параметры

`(объект)` Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

|Параметр|Тип|Описание|
|----------------|------|----------------|
|groupids|строка/массив|Возврат только тех скриптов, которые могут запускаться на заданных группах узлов сети.|
|hostids|строка/массив|Возврат только тех скриптов, которые могут запускаться на заданных узлах сети.|
|scriptids|строка/массив|Возвра скриптов только с заданными ID.|
|usrgrpids|строка/массив|Возврат только тех скриптов, которые могут быть запущены пользователями из заданных групп пользователей.|
|selectGroups|запрос|Возврат групп узлов сети, на которых скрипт может быть запущен, в свойстве `groups`.|
|selectHosts|запрос|Возврат узлов сети, на которых скрипт может быть запущен, в свойстве `hosts`.|
|sortfield|строка/массив|Сортировка результата в соответствии с заданными свойствами.<br><br>Возможные значения: `scriptid` и `name`.|
|countOutput|логический|Эти параметры являются общими для всех методов `get` и они описаны в [справочных комментариях](/ru/manual/api/reference_commentary#общие_параметры_get_метода).|
|editable|логический|^|
|excludeSearch|логический|^|
|filter|объект|^|
|limit|целое число|^|
|output|запрос|^|
|preservekeys|логический|^|
|search|объект|^|
|searchByAny|логический|^|
|searchWildcardsEnabled|логический|^|
|sortorder|строка/массив|^|
|startSearch|логический|^|

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

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({new-6d428f32})
#### Получение всех скриптов

Получение всех добавленных скриптов.

Запрос:

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

Ответ:

``` {.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]: # ({/new-6d428f32})

[comment]: # ({b0b740ec-b0b740ec})
### Смотрите также

-   [Узел сети](/manual/api/reference/host/object#object_details)
-   [Группа узлов сети](/manual/api/reference/hostgroup/object#object_details)

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

[comment]: # ({90dfc753-90dfc753})
### Источник

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

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