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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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. Этот модуль предоставляет реализацию для работы с операциями SONiC REST детерминированным способом.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр	Комментарии
body любой	Тело HTTP-запроса/ответа веб-сервису, содержащее полезную нагрузку.
method строка / обязательно	HTTP-метод запроса или ответа. Должен быть допустимым методом, принимаемым службой, обрабатывающей запрос. Варианты: `"GET"` `"PUT"` `"POST"` `"PATCH"` `"DELETE"`
status_code список / элементы=целое число / обязательно	Список допустимых числовых HTTP-кодов состояния, указывающих на успешность запроса.
url путь / обязательно	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 строка	Сообщение об ошибке HTTP из запроса. Возвращается: HTTP Ошибка
response список / элементы=строка	Ответ на устройстве сети для вызова REST, содержащий код состояния. Возвращается: всегда Пример: `{"response": [204, {"": null}]}`

Авторы

Abirami N (@abirami-n)

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

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