FindObjectsIdsByParam - Найти ID объектов дерева по параметру
Общая информация
-
Команда служит для поиска объектов дерева по заданному параметру
-
Существует ограничение по параметрам, по которым доступен поиск. Запрещенные параметры для поиска
-
Значение параметра поиска можно задать пустым
-
Команда актуальна, начиная с версии 1.22
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата | Ссылка |
|---|---|---|---|---|
parameter |
Параметр для поиска |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
ids |
Массив идентификаторов объектов в дереве |
Integer |
code |
Код ответа |
int |
detail |
Пояснение к ответу |
String |
Основные параметры для поиска
| Параметр | Значение | Формат значения |
|---|---|---|
name |
Имя устройства/узла |
String |
type |
Тип |
String |
subtype |
Подтип устройства |
String |
Запрещенные параметры для поиска
| Параметр | Значение |
|---|---|
AuthPassword |
Write community / Password v3 |
AuthProtocol |
Протокол аутентификации |
NetconfPassword |
Netconf Password |
password |
Пароль для автоматического подключения по Telnet/SSH |
PrivacyPassword |
Ключ шифрования |
WebPassword |
Пароль для автоматического подключения по Web |
Коды ответа
| Код | Описание |
|---|---|
0 |
Успешно |
2 |
Ошибка с БД |
29 |
Пустой параметр |
538 |
Запрещенный параметр |
Пример использования
Запрос
<soap:Envelope>
<soap:Header/>
<soap:Body>
<nbi:FindObjectsIdsByParam>
<nbi:parameter>
<xsd:name>IpAddress</xsd:name>
<xsd:value>10.25.96.115</xsd:value>
</nbi:parameter>
</nbi:FindObjectsIdsByParam>
</soap:Body>
</soap:Envelope>Ответ
<soapenv:Envelope>
<soapenv:Body>
<ns:FindObjectsIdsByParamResponse>
<ns:return>
<ax21:code>0</ax21:code>
<ax21:detail>Success</ax21:detail>
<ax21:ids>352982</ax21:ids>
</ns:return>
</ns:FindObjectsIdsByParamResponse>
</soapenv:Body>
</soapenv:Envelope>