GetFullTreeObj - Получить информацию об объекте дерева по уникальному параметру
Общая информация
-
Команда служит для получения полной информации об объекте дерева по заданному уникальному параметру. Список параметров, по которым возможен поиск.
-
Существует ограничение по параметрам, которые можно получить методом
GetFullTreeObj. Список параметров, которые нельзя получить методом GetFullTreeObj. -
Доступные для поиска параметры подразумеваются уникальными, поэтому в случае нахождения более одного объекта, будет возвращена ошибка.
-
Команда актуальна, начиная с версии 1.24
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата | Ссылка |
|---|---|---|---|---|
parameter |
Параметр для поиска |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
code |
Код ответа |
Integer |
detail |
Пояснение к ответу |
String |
response |
Массив объектов NbiParameter. Содержит название атрибута и его значение. |
NbiParameterArray |
Доступные для поиска параметры
| Параметр | Значение | Формат значения |
|---|---|---|
id |
ID объекта в дереве объектов EMS |
Integer |
name |
Имя устройства/узла |
String |
ip |
IP-адрес устройства |
^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ |
mac |
MAC-адрес устройства |
^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$ |
Параметры, которые не войдут в результат
| Параметр | Значение |
|---|---|
AuthPassword |
Write community / Password v3 |
AuthProtocol |
Протокол аутентификации |
NetconfPassword |
Пароль для автоматического подключения по netconf |
login |
Имя пользователя для автоматического подключения по Telnet/SSH |
password |
Пароль для автоматического подключения по Telnet/SSH |
PrivacyPassword |
Ключ шифрования |
WebPassword |
Пароль для автоматического подключения по Web |
Коды ответа
| Код | Описание |
|---|---|
0 |
Успешно |
2 |
Ошибка с БД |
7 |
Не удалось получить домен объекта дерева (для проверки доступа) |
10 |
У роли нет доступа до объекта |
30 |
Некорректный IP-адрес |
63 |
Некорректный MAC-адрес |
416 |
Не удалось получить объект дерева по заданному параметру |
502 |
Пустое имя параметра |
503 |
Пустое значение параметра |
538 |
Запрещенный параметр |
539 |
Параметр id должен быть целым положительным числом |
543 |
По указанному параметру найдено более одного объекта |
Пример использования
Запрос
<soap:Envelope>
<soap:Header/>
<soap:Body>
<nbi:GetFullTreeObject>
<nbi:parameter>
<xsd:name>ip</xsd:name>
<xsd:value>10.25.96.115</xsd:value>
</nbi:parameter>
</nbi:GetFullTreeObject>
</soap:Body>
</soap:Envelope>Ответ
<soapenv:Envelope>
<soapenv:Body>
<ns:GetFullTreeObjectResponse>
<ns:return>
<ax21:code>0</ax21:code>
<ax21:detail>Success</ax21:detail>
<ax21:response>
<ax21:parameter>
<ax21:name>Zip</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Port</ax21:name>
<ax21:value>161</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>ESRname</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>pid</ax21:name>
<ax21:value>383961</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Latitude</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>BrasService</ax21:name>
<ax21:value>false</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Version</ax21:name>
<ax21:value>v2c</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>SecurityLevel</ax21:name>
<ax21:value>AUTH_NO_PRIV</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Street</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>id</ax21:name>
<ax21:value>383963</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>UseExternalAcs</ax21:name>
<ax21:value>false</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>BlockTraps</ax21:name>
<ax21:value>Accept</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Status</ax21:name>
<ax21:value>WRONG</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>sshPort</ax21:name>
<ax21:value>22</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>OutOfService</ax21:name>
<ax21:value>false</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Timeout</ax21:name>
<ax21:value>60000</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>City</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>MacAddress</ax21:name>
<ax21:value>AA:AA:AA:AA:AA:E0</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Longitude</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>ename</ax21:name>
<ax21:value>WEP-12ac_123</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>NetconfSeparator</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>FileTransport</ax21:name>
<ax21:value>TFTP</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Country</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Region</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>District</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Building</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Office</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>HouseNumber</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Description</ax21:name>
<ax21:value>нет</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>AuthName</ax21:name>
<ax21:value>public</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>ClusterMode</ax21:name>
<ax21:value>None</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>INN</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>NetconfPort</ax21:name>
<ax21:value>830</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>NetconfLogin</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>RealUsed_WIPS_WIDS</ax21:name>
<ax21:value>0</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>OttMode</ax21:name>
<ax21:value>None</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>initSeparator</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>DpiStepLogic</ax21:name>
<ax21:value>false</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>etype</ax21:name>
<ax21:value>WEP</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>WIPS_WIDS_Service</ax21:name>
<ax21:value>false</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>ActNumber</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>PrivacyProtocol</ax21:name>
<ax21:value>DES</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>Floor</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>OutOfServiceDate</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>WebLogin</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>SnmpTransport</ax21:name>
<ax21:value>UDP</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>esubtype</ax21:name>
<ax21:value>-12ac</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>StatusDate</ax21:name>
<ax21:value>06.07.2022 16:46:34</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>FullName</ax21:name>
<ax21:value>admin</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>TunnelIpAddr</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>IpAddress</ax21:name>
<ax21:value>10.25.96.115</ax21:value>
</ax21:parameter>
<ax21:parameter>
<ax21:name>RegionId</ax21:name>
<ax21:value/>
</ax21:parameter>
<ax21:parameter>
<ax21:name>initTime</ax21:name>
<ax21:value>11.06.2022 12:06:38</ax21:value>
</ax21:parameter>
</ax21:response>
</ns:return>
</ns:GetFullTreeObjectResponse>
</soapenv:Body>
</soapenv:Envelope>