Модуль dellemc.enterprise_sonic.sonic_api — управление операциями REST на устройствах под управлением Enterprise SONiC

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

Чтобы использовать ее в плейбуке, укажите: dellemc.enterprise_sonic.sonic_api.

Добавлено в dellemc.enterprise_sonic 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет операциями REST на устройствах под управлением Enterprise SONiC Distribution от Dell Technologies. Этот модуль реализует детерминированный подход к работе с операциями REST SONiC.

Параметры

Параметр	Комментарии
body any	Тело HTTP-запроса/ответа веб-службы, содержащее полезную нагрузку.
method string / обязательный	Метод HTTP-запроса или ответа. Должен быть допустимым методом, принимаемым службой, обрабатывающей запрос. Допустимые значения: `"GET"` `"PUT"` `"POST"` `"PATCH"` `"DELETE"`
status_code list / элементы=целое число / обязательный	Список допустимых числовых кодов состояния HTTP, указывающих на успешное выполнение запроса.
url path / обязательный	Путь HTTP-запроса после «restconf/».

Примечания

Примечание

Проверено на Enterprise SONiC Distribution от Dell Technologies.
Поддерживает check_mode.

Примеры

- name: Checks that you can connect (GET) to a page and it returns a status 200
  dellemc.enterprise_sonic.sonic_api:
    url: data/openconfig-interfaces:interfaces/interface=Ethernet60
    method: "GET"
    status_code: 200

- name: Appends data to an existing interface using PATCH and verifies if it returns status 204
  dellemc.enterprise_sonic.sonic_api:
    url: data/openconfig-interfaces:interfaces/interface=Ethernet60/config/description
    method: "PATCH"
    body: {"openconfig-interfaces:description": "Eth-60"}
    status_code: 204

- name: Deletes an associated IP address using DELETE and verifies if it returns status 204
  dellemc.enterprise_sonic.sonic_api:
    url: >
      data/openconfig-interfaces:interfaces/interface=Ethernet64/subinterfaces/subinterface=0/
      openconfig-if-ip:ipv4/addresses/address=1.1.1.1/config/prefix-length
    method: "DELETE"
    status_code: 204

- name: Adds a VLAN network instance using PUT and verifies if it returns status 204
  dellemc.enterprise_sonic.sonic_api:
    url: data/openconfig-network-instance:network-instances/network-instance=Vlan100/
    method: "PUT"
    body: {"openconfig-network-instance:network-instance": [{"name": "Vlan100", "config": {"name": "Vlan100"}}]}
    status_code: 204

- name: Adds a prefix-set to a routing policy using POST and verifies if it returns 201
  dellemc.enterprise_sonic.sonic_api:
    url: data/openconfig-routing-policy:routing-policy/defined-sets/prefix-sets/prefix-set=p1
    method: "POST"
    body: {"openconfig-routing-policy:config": {"name": "p1", "mode": "IPV4" }}
    status_code: 201

Возвращаемые значения

Общие возвращаемые значения описаны здесь; далее перечислены поля, характерные для этого модуля:

Ключ	Описание
msg string	Сообщение об ошибке HTTP из запроса. Возвращается: ошибка HTTP
response list / элементы=строка	Ответ сетевого устройства на вызов REST, содержащий код состояния. Возвращается: всегда Пример: `{"response": [204, {"": null}]}`

Авторы

Abirami N (@abirami-n)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_api_module.html