Модуль community.network.opx_cps – операции CPS на сетевом устройстве под управлением Openswitch (OPX)

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

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

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.network.opx_cps.

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

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

Выполняет заданную операцию над объектом YANG, используя API CPS на сетевом устройстве под управлением OpenSwitch (OPX). Он использует модели YANG, предоставленные в https://github.com/open-switch/opx-base-model.

Псевдонимы: network.opx.opx_cps

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

cps
cps_object
cps_utils

Параметры

Параметр	Комментарии
attr_data string	Путь к атрибуту Yang и соответствующие данные.
attr_type string	Тип атрибута Yang.
commit_event boolean	Пытается принудительно выполнить событие авто-фиксации для указанного объекта yang. Варианты: `false` ← (по умолчанию) `true`
db boolean	Запрашивает/записывает указанный путь yang из/в базу данных. Варианты: `false` ← (по умолчанию) `true`
module_name string	Путь Yang для настройки.
operation string	Операция, которая должна быть выполнена над объектом. Варианты: `"delete"` `"create"` ← (по умолчанию) `"set"` `"action"` `"get"`
qualifier string	Квалификатор указывает тип данных объекта для извлечения или обработки. Варианты: `"target"` ← (по умолчанию) `"observed"` `"proposed"` `"realtime"` `"registration"` `"running"` `"startup"`

Примеры

- name: Create VLAN
  community.network.opx_cps:
    module_name: "dell-base-if-cmn/if/interfaces/interface"
    attr_data: {
         "base-if-vlan/if/interfaces/interface/id": 230,
         "if/interfaces/interface/name": "br230",
         "if/interfaces/interface/type": "ianaift:l2vlan"
    }
    operation: "create"
- name: Get VLAN
  community.network.opx_cps:
    module_name: "dell-base-if-cmn/if/interfaces/interface"
    attr_data: {
         "if/interfaces/interface/name": "br230",
    }
    operation: "get"
- name: Modify some attributes in VLAN
  community.network.opx_cps:
    module_name: "dell-base-if-cmn/if/interfaces/interface"
    attr_data: {
         "cps/key_data":
            { "if/interfaces/interface/name": "br230" },
         "dell-if/if/interfaces/interface/untagged-ports": ["e101-008-0"],
    }
    operation: "set"
- name: Delete VLAN
  community.network.opx_cps:
    module_name: "dell-base-if-cmn/if/interfaces/interface"
    attr_data: {
         "if/interfaces/interface/name": "br230",
    }
    operation: "delete"

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

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

Ключ	Описание
commit_event boolean	Указывает, установлено ли событие авто-фиксации Возвращается: когда commit_event установлен в True в параметрах модуля Пример: `true`
cps_curr_config dictionary	Возвращает результат CPS Get, т.е. текущую конфигурацию до выполнения операции CPS set/delete Возвращается: при операциях CPS set, delete Пример: [{"data": {"base-if-vlan/if/interfaces/interface/id": 230, "cps/key_data": {"if/interfaces/interface/name": "br230"}, "dell-base-if-cmn/if/interfaces/interface/if-index": 44, "dell-if/if/interfaces/interface/learning-mode": 1, "dell-if/if/interfaces/interface/mtu": 1532, "dell-if/if/interfaces/interface/phys-address": "", "dell-if/if/interfaces/interface/vlan-type": 1, "if/interfaces/interface/enabled": 0, "if/interfaces/interface/type": "ianaift:l2vlan"}, "key": "target/dell-base-if-cmn/if/interfaces/interface"}]
db boolean	Указывает, была ли выполнена транзакция CPS DB Возвращается: когда db установлен в True в параметрах модуля Пример: `true`
diff dictionary	Фактическая конфигурация, которая будет отправлена, сравнивая текущую конфигурацию и входные атрибуты Возвращается: при операциях CPS set, delete Пример: `{"cps/key_data": {"if/interfaces/interface/name": "br230"}, "dell-if/if/interfaces/interface/untagged-ports": ["e101-007-0"]}`
response list / elements=string	Вывод из транзакции CPS. Вывод операции CPS Get, если CPS set/create/delete не выполнены. Возвращается: когда транзакция CPS успешно выполнена. Пример: `[{"data": {"base-if-vlan/if/interfaces/interface/id": 230, "cps/object-group/return-code": 0, "dell-base-if-cmn/if/interfaces/interface/if-index": 46, "if/interfaces/interface/name": "br230", "if/interfaces/interface/type": "ianaift:l2vlan"}, "key": "target/dell-base-if-cmn/if/interfaces/interface"}]`

Авторы

Senthil Kumar Ganesan (@skg-net)

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

© 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/community/network/opx_cps_module.html