opx_cps – Операции CPS на сетевом устройстве с OpenSwitch (OPX)

Новое в версии 2.7.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения
Статус

Обзор

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

Требования

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

cps
cps_object
cps_utils

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attr_data -		Путь YANG атрибута и соответствующие данные.
attr_type -		Тип YANG атрибута.
commit_event boolean	Варианты: нет ← да	Попытка принудительного вызова события авто-коммита для указанного объекта yang.
db boolean	Варианты: нет ← да	Запрос/запись указанного пути yang в/из базы данных.
module_name -		Путь yang, который должен быть настроен.
operation -	Варианты: удаление создание ← установка действие получение	Операция, которая должна быть выполнена над объектом.
qualifier -	Варианты: цель ← наблюдаемый предлагаемый реальный регистрация запущенный стартовый	Квалификатор определяет тип данных объекта, который необходимо получить или обработать.

Примеры

- name: Create VLAN
  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
  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
  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
  opx_cps:
    module_name: "dell-base-if-cmn/if/interfaces/interface"
    attr_data: {
         "if/interfaces/interface/name": "br230",
    }
    operation: "delete"

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

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

Ключ	Возвращаемое значение	Описание
candidate словарь	все операции CPS, кроме "get"	Данные атрибутов ввода CPS, используемые для сравнения с рабочей конфигурацией Пример: {'base-if-vlan/if/interfaces/interface/id': 230, 'if/interfaces/interface/name': 'br230', 'if/interfaces/interface/type': 'ianaift:l2vlan'}
commit_event boolean	когда commit_event установлен в True в параметрах модуля	Указывает, установлено ли событие авто-коммита Пример: True
config словарь	при операциях CPS set, delete	Возвращает выход CPS Get, т.е. рабочую конфигурацию до выполнения транзакции CPS Пример: {'base-if-vlan/if/interfaces/interface/id': 230, 'dell-base-if-cmn/if/interfaces/interface/if-index': 46, '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/name': 'br230', 'if/interfaces/interface/type': 'ianaift:l2vlan'}
db boolean	когда db установлен в True в параметрах модуля	Указывает, была ли выполнена транзакция CPS с базой данных Пример: True
diff словарь	все операции CPS, кроме "get"	Фактическая конфигурация, которая будет применена, сравнивая рабочую конфигурацию и входные атрибуты Пример: {'base-if-vlan/if/interfaces/interface/id': 230, 'if/interfaces/interface/name': 'br230', 'if/interfaces/interface/type': 'ianaift:l2vlan'}
response список	при успешном выполнении транзакции CPS.	Вывод транзакции 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'}]

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Senthil Kumar Ganesan (@skg-net)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/opx_cps_module.html