community.network.ce_bfd_view – Управляет конфигурацией представлений сеансов BFD на устройствах HUAWEI CloudEngine.

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

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

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

Обзор

Управляет конфигурацией представлений сеансов BFD на устройствах HUAWEI CloudEngine.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin_down boolean		Варианты: нет ← да	Включает состояние AdminDown для сеанса BFD. По умолчанию сеанс BFD включен. Значение по умолчанию - булевый тип.
description строка			Указывает описание сеанса BFD. Значение - строка от 1 до 51 символа, чувствительная к регистру, с пробелами.
detect_multi строка			Указывает локальный множитель обнаружения для сеанса BFD. Значение - целое число от 3 до 50.
local_discr строка			Указывает локальный дискриминатор для сеанса BFD. Значение - целое число от 1 до 16384.
min_rx_interval строка			Указывает минимальный интервал для отправки пакетов BFD. Значение - целое число от 50 до 1000 миллисекунд.
min_tx_interval строка			Указывает минимальный интервал для приема пакетов BFD. Значение - целое число от 50 до 1000 миллисекунд.
provider строка			Объект типа dict, содержащий данные подключения.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число	По умолчанию: "0 (использовать общий порт)"	Указывает порт для подключения к удаленному устройству. Это значение относится как к cli, так и к netconf. Если порт не указан в задаче, используется соответствующий общий порт транспорта (cli=22, netconf=22).
	ssh_keyfile путь		Указывает SSH ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	transport строка / обязательно	Варианты: cli ← netconf	Настраивает транспортное подключение для соединения с удаленным устройством. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh).
	username строка		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
remote_discr строка			Указывает удаленный дискриминатор для сеанса BFD. Значение - целое число от 1 до 4294967295.
session_name строка / обязательно			Указывает имя сеанса BFD. Значение - строка от 1 до 15 символов, чувствительная к регистру, без пробелов.
state строка		Варианты: наличие ← отсутствие	Определяет, должно ли конфигурация присутствовать на устройстве или нет.
tos_exp строка			Указывает приоритет пакетов управления BFD. Значение - целое число от 0 до 7. Значение по умолчанию - 7, что соответствует наивысшему приоритету.
wtr_interval строка			Указывает время WTR для сеанса BFD. Значение - целое число от 1 до 60 минут. Значение по умолчанию - 0.

Примечания

Примечание

Для данного модуля необходимо, чтобы служба netconf была включена на управляемом удаленном устройстве.
Рекомендуемое подключение - netconf.
Этот модуль также работает с local подключениями для устаревших playbooks.

Примеры

- name: Bfd view module test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:
  - name: Set the local discriminator of a BFD session to 80 and the remote discriminator to 800
    community.network.ce_bfd_view:
      session_name: atob
      local_discr: 80
      remote_discr: 800
      state: present
      provider: '{{ cli }}'

  - name: Set the minimum interval for receiving BFD packets to 500 ms
    community.network.ce_bfd_view:
      session_name: atob
      min_rx_interval: 500
      state: present
      provider: '{{ cli }}'

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

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	Проверка, были ли внесены изменения на устройстве Пример: True
end_state словарь	всегда	k/v пары конфигурации после выполнения модуля Пример: {'session': {'adminDown': 'false', 'createType': 'SESS_STATIC', 'description': None, 'detectMulti': '3', 'localDiscr': '80', 'minRxInt': None, 'minTxInt': None, 'remoteDiscr': '800', 'sessName': 'atob', 'tosExp': None, 'wtrTimerInt': None}}
existing словарь	всегда	k/v пары существующей конфигурации Пример: {'session': {'adminDown': 'false', 'createType': 'SESS_STATIC', 'description': None, 'detectMulti': '3', 'localDiscr': None, 'minRxInt': None, 'minTxInt': None, 'remoteDiscr': None, 'sessName': 'atob', 'tosExp': None, 'wtrTimerInt': None}}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'admin_down': False, 'description': None, 'detect_multi': None, 'local_discr': 80, 'min_rx_interval': None, 'min_tx_interval': None, 'remote_discr': 800, 'session_name': 'atob', 'state': 'present', 'tos_exp': None, 'wtr_interval': None}
updates список / элементы=строка	всегда	команды, отправленные на устройство Пример: ['bfd atob', 'discriminator local 80', 'discriminator remote 800']

Авторы

QijunPan (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ce_bfd_view_module.html