ce_bfd_view - Управляет конфигурацией представления сеансов BFD на устройствах HUAWEI CloudEngine.
Новое в версии 2.4.
Обзор
- Управляет конфигурацией представления сеансов BFD на устройствах HUAWEI CloudEngine.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_down bool |
| Включает сеанс BFD в состояние AdminDown. По умолчанию сеанс 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 используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при установлении подключения к удаленному устройству. Это значение относится к cli или netconf. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если он не задан в задаче (cli=22, netconf=22). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это распространенный аргумент для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh). | |
| remote_discr | Указывает удаленный дискриминатор сеанса BFD. Значение — целое число от 1 до 4294967295. | ||
| session_name обязательно | Указывает имя сеанса BFD. Значение — строка от 1 до 15 символов, чувствительная к регистру, без пробелов. | ||
| state |
| Определяет, должен ли конфигурация быть присутствовать на устройстве. | |
| tos_exp | Указывает приоритет для пакетов управления BFD. Значение — целое число от 0 до 7. Значение по умолчанию — 7 (наивысший приоритет). | ||
| wtr_interval | Указывает время WTR сеанса BFD. Значение — целое число от 1 до 60 минут. Значение по умолчанию — 0. | ||
Примеры
- 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 dict | всегда | 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 dict | всегда | 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 dict | всегда | 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 list | всегда | команды, отправленные на устройство Пример: ['bfd atob', 'discriminator local 80', 'discriminator remote 800'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- QijunPan (@CloudEngine-Ansible)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ce_bfd_view_module.html