community.network.ce_bfd_view – Управляет конфигурацией представления сеанса BFD на устройствах HUAWEI CloudEngine.
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.ce_bfd_view.
Обзор
- Управляет конфигурацией представления сеанса BFD на устройствах HUAWEI CloudEngine.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_down boolean |
| Включает состояние AdminDown для сеанса BFD. По умолчанию сеанс BFD включен. Значение по умолчанию - булево значение. | |
| description string | Указывает описание сеанса BFD. Значение — строка от 1 до 51 символа, регистрозависимая, с пробелами. | ||
| detect_multi string | Указывает локальный множитель обнаружения сеанса BFD. Значение — целое число от 3 до 50. | ||
| local_discr string | Указывает локальный дискриминатор сеанса BFD. Значение — целое число от 1 до 16384. | ||
| min_rx_interval string | Указывает минимальный интервал для отправки пакетов BFD. Значение — целое число от 50 до 1000 миллисекунд. | ||
| min_tx_interval string | Указывает минимальный интервал для получения пакетов BFD. Значение — целое число от 50 до 1000 миллисекунд. | ||
| provider string | Объект словаря, содержащий сведения о подключении. | ||
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | По умолчанию: "0 (использовать общий порт)" | Указывает порт для создания подключения к удалённому устройству. Это значение относится к транспорту cli или netconf. Значение порта будет по умолчанию соответствовать общему порту транспорта, если оно не указано в задаче. (cli=22, netconf=22). | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется для транспорта cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport string / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh). | |
| username string | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа CLI. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| remote_discr string | Указывает удаленный дискриминатор сеанса BFD. Значение — целое число от 1 до 4294967295. | ||
| session_name string / обязательно | Указывает имя сеанса BFD. Значение — строка от 1 до 15 символов, регистрозависимая, без пробелов. | ||
| state string |
| Определяет, должно ли быть конфигурирование присутствующим на устройстве или нет. | |
| tos_exp string | Указывает приоритет пакетов управления BFD. Значение — целое число от 0 до 7. Значение по умолчанию 7, что является наивысшим приоритетом. | ||
| wtr_interval string | Указывает время WTR сеанса BFD. Значение — целое число от 1 до 60 минут. Значение по умолчанию 0. | ||
Примечания
Примечание
- Для этого модуля необходимо, чтобы служба netconf была включена на удалённом управляемом устройстве.
- Рекомендуемое соединение
netconf. - Этот модуль также работает с
localподключениями для устаревших книг задач.
Примеры
- 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 словарь | всегда | пара пары ключ/значение конфигурации после выполнения модуля Пример: {'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 словарь | всегда | пара пары ключ/значение существующей конфигурации Пример: {'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 словарь | всегда | пара пары ключ/значение параметров, переданных в модуль Пример: {'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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_bfd_view_module.html