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

Новая в версии 2.4.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin_down boolean		Варианты: нет ← да	Включает состояние AdminDown для сеанса BFD. По умолчанию сеанс BFD включен. Значение по умолчанию — тип bool.
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 -		Варианты: present ← absent	Определяет, должно ли быть конфигурация присутствовать на устройстве.
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
    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
    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']

Статус

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

Авторы

QijunPan (@QijunPan)

Подсказка

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

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