community.network.ce_bgp_neighbor – Управляет конфигурацией BGP-пиров на коммутаторах HUAWEI CloudEngine.
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в плейбуке укажите: community.network.ce_bgp_neighbor
Обзор
- Управляет конфигурацией BGP-пиров на коммутаторах HUAWEI CloudEngine.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| conn_retry_time строка | Интервал повторной попытки подключения. Значение — целое число от 1 до 65535. | |
| connect_mode строка | Значение может быть Connect-only, Listen-only или Both. | |
| conventional строка |
| Если значение true, маршрутизатор имеет все расширенные возможности. Если значение false, маршрутизатор не имеет всех расширенных возможностей. |
| description строка | Описание пира, которое может содержать буквы или цифры. Значение — строка от 1 до 80 символов. | |
| dual_as строка |
| Если значение true, EBGP-пир может использовать либо подставной номер AS, либо фактический номер AS. Если значение false, EBGP-пир может использовать только подставной номер AS. |
| ebgp_max_hop строка | Максимальное количество хопов в непрямом EBGP-соединении. Значение — целое число от 1 до 255. | |
| fake_as строка | Подставной номер AS, указанный для локального пира. Значение — строка от 1 до 11 символов. | |
| hold_time строка | Указывает время удержания пира или группы пиров. Значение — 0 или целое число от 3 до 65535. | |
| is_bfd_block строка |
| Если значение true, пиры включены для наследования функции BFD от группы пиров. Если значение false, пиры отключены для наследования функции BFD от группы пиров. |
| is_bfd_enable строка |
| Если значение true, BFD включен. Если значение false, BFD отключен. |
| is_ignore строка |
| Если значение true, сессия с указанным пиром разрывается, и все связанные маршрутные записи очищаются. Если значение false, сессия с указанным пиром сохраняется. |
| is_log_change строка |
| Если значение true, BGP включен для записи состояния сессии пира и информации об событиях. Если значение false, BGP отключен от записи состояния сессии пира и информации об событиях. |
| is_single_hop строка |
| Если значение true, система включена для предпочтительного использования одноходового режима для настройки сессии BFD между IBGP-пирами. Если значение false, система отключена от предпочтительного использования одноходового режима для настройки сессии BFD между IBGP-пирами. |
| keep_alive_time строка | Указывает время keepalive пира или группы пиров. Значение — целое число от 0 до 21845. Значение по умолчанию — 60. | |
| key_chain_name строка | Укажите имя цепочки ключей для аутентификации, используемой при установлении TCP-соединения BGP-пирами. Значение — строка от 1 до 47 символов без учета регистра. | |
| local_if_name строка | Имя исходного интерфейса, отправляющего пакеты BGP. Значение — строка от 1 до 63 символов. | |
| min_hold_time строка | Указывает минимальное время удержания пира или группы пиров. | |
| mpls_local_ifnet_disable строка |
| Если значение true, пир создает MPLS Local IFNET disable. Если значение false, пир создает MPLS Local IFNET enable. |
| multiplier строка | Укажите множитель обнаружения. Значение по умолчанию — 3. Значение — целое число от 3 до 50. | |
| peer_addr строка / обязательно | Адрес подключения пира, который может быть IPv4 или IPv6 адресом. | |
| prepend_fake_as строка |
| Добавить подставной номер AS в принимаемые пакеты Update. |
| prepend_global_as строка |
| Добавить глобальный номер AS в пакеты Update для рекламы. |
| pswd_cipher_text строка | Строка символов в пароле идентифицирует содержимое пароля, пробелы не поддерживаются. Значение — строка от 1 до 255 символов. | |
| pswd_type строка |
| Разрешить BGP-пирам устанавливать TCP-соединение и выполнять аутентификацию Message Digest 5 (MD5) для сообщений BGP. |
| remote_as строка / обязательно | Номер AS пира. Значение — строка от 1 до 11 символов. | |
| route_refresh строка |
| Если значение true, BGP включен для рекламы пакетов REFRESH. Если значение false, функция обновления маршрутов включена. |
| rx_interval строка | Указывает минимальный интервал, с которым принимаются пакеты BFD. Значение — целое число от 50 до 1000 миллисекунд. | |
| state строка |
| Укажите желаемое состояние ресурса. |
| tcp_MSS строка | Максимальное значение TCP MSS, используемое для установления TCP-соединения для пира. Значение — целое число от 176 до 4096. | |
| tx_interval строка | Укажите минимальный интервал, с которым отправляются пакеты BFD. Значение — целое число от 50 до 1000 миллисекунд. | |
| valid_ttl_hops строка | Включить GTSM для пира или группы пиров. Параметр valid-TTL-Value используется для указания количества хопов TTL для обнаружения. Значение — целое число от 1 до 255. | |
| vrf_name строка / обязательно | Имя экземпляра BGP. Имя — строка символов, чувствительная к регистру. Экземпляр BGP можно использовать только после создания соответствующего экземпляра VPN. |
Примечания
Примечание
- Для работы данного модуля необходимо включить системную службу netconf на удалённом управляемом устройстве.
- Рекомендуемое соединение —
netconf. - Этот модуль также работает с
localсоединениями для устаревших playbooks.
Примеры
- name: CloudEngine BGP neighbor 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: "Config bgp peer"
community.network.ce_bgp_neighbor:
state: present
vrf_name: js
peer_addr: 192.168.10.10
remote_as: 500
provider: "{{ cli }}"
- name: "Config bgp route id"
community.network.ce_bgp_neighbor:
state: absent
vrf_name: js
peer_addr: 192.168.10.10
provider: "{{ cli }}"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | проверка, было ли внесено изменение на устройстве Пример: True |
| end_state словарь | всегда | пара Ключ/Значение параметров aaa после выполнения модуля Пример: {'bgp peer': [['192.168.10.10', '500']]} |
| existing словарь | всегда | пара Ключ/Значение существующего aaa сервера Пример: {'bgp peer': []} |
| proposed словарь | всегда | пара Ключ/Значение параметров, переданных в модуль Пример: {'peer_addr': '192.168.10.10', 'remote_as': '500', 'state': 'present', 'vrf_name': 'js'} |
| updates список / элементы=строка | всегда | команда, отправленная устройству Пример: ['peer 192.168.10.10 as-number 500'] |
Авторы
- wangdezhuang (@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_bgp_neighbor_module.html