ce_bgp_neighbor - Управляет настройкой BGP-пейров на коммутаторах HUAWEI CloudEngine.
Новая версия 2.4.
Описание
- Управляет настройками BGP-пейров на коммутаторах HUAWEI CloudEngine.
Параметры
| параметр | обязательный | по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| conn_retry_time | нет | Интервал повторной попытки подключения. Значение — целое число от 1 до 65535. | ||
| connect_mode | нет | Значение может быть Connect-only, Listen-only или Both. | ||
| conventional | нет | no_use |
| Если значение true, маршрутизатор имеет все расширенные возможности. Если значение false, маршрутизатор не имеет всех расширенных возможностей. |
| description | нет | Описание пейра, которое может содержать буквы или цифры. Значение — строка длиной от 1 до 80 символов. | ||
| dual_as | нет | no_use |
| Если значение 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 | нет | no_use |
| Если значение true, пейры могут унаследовать функцию BFD от группы пейров. Если значение false, пейры не могут унаследовать функцию BFD от группы пейров. |
| is_bfd_enable | нет | no_use |
| Если значение true, BFD включен. Если значение false, BFD выключен. |
| is_ignore | нет | no_use |
| Если значение true, сессия со указанным пейром разрывается, и все связанные маршрутные записи удаляются. Если значение false, сессия со указанным пейром сохраняется. |
| is_log_change | нет | no_use |
| Если значение true, BGP записывает состояние сессий пейров и информацию о событиях. Если значение false, BGP не записывает состояние сессий пейров и информацию о событиях. |
| is_single_hop | нет | no_use |
| Если значение true, система предпочитает использовать одноходовой режим для настройки сессий BFD между IBGP-пейрами. Если значение false, система не предпочитает использовать одноходовой режим для настройки сессий BFD между IBGP-пейрами. |
| keep_alive_time | нет | Указывает время keepalive пейра или группы пейров. Значение — целое число от 0 до 21845. Значение по умолчанию — 60. | ||
| key_chain_name | нет | Указывает имя цепочки ключей аутентификации, используемой при установлении BGP-пейрами TCP-соединения. Значение — строка длиной от 1 до 47 символов, регистронезависимое. | ||
| local_if_name | нет | Имя интерфейса источника, который отправляет пакеты BGP. Значение — строка длиной от 1 до 63 символов. | ||
| min_hold_time | нет | Указывает минимальное время удержания пейра или группы пейров. | ||
| mpls_local_ifnet_disable | нет | no_use |
| Если значение true, для пейра отключается MPLS Local IFNET. Если значение false, для пейра включается MPLS Local IFNET. |
| multiplier | нет | Указывает множитель обнаружения. Значение по умолчанию — 3. Значение — целое число от 3 до 50. | ||
| peer_addr | да | Адрес подключения пейра, который может быть IPv4 или IPv6 адресом. | ||
| prepend_fake_as | нет | no_use |
| Добавить фальшивый номер AS в полученные пакеты Update. |
| prepend_global_as | нет | no_use |
| Добавить глобальный номер AS в пакеты Update для распространения. |
| pswd_cipher_text | нет | Строка символов в пароле определяет содержимое пароля, пробелы не поддерживаются. Значение — строка длиной от 1 до 255 символов. | ||
| pswd_type | нет |
| Разрешить BGP-пейрам устанавливать TCP-соединение и выполнять аутентификацию сообщений BGP с помощью Message Digest 5 (MD5). | |
| remote_as | да | Номер AS пейра. Значение — строка длиной от 1 до 11 символов. | ||
| route_refresh | нет | no_use |
| Если значение true, BGP разрешено рекламировать пакеты REFRESH. Если значение false, функция обновления маршрутов включена. |
| rx_interval | нет | Указывает минимальный интервал приема пакетов BFD. Значение — целое число от 50 до 1000, в миллисекундах. | ||
| state | нет | present |
| Указывает желаемое состояние ресурса. |
| 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. |
Примеры
- 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"
ce_bgp_neighbor:
state: present
vrf_name: js
peer_addr: 192.168.10.10
remote_as: 500
provider: "{{ cli }}"
- name: "Config bgp route id"
ce_bgp_neighbor:
state: absent
vrf_name: js
peer_addr: 192.168.10.10
provider: "{{ cli }}"
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие — поля, уникальные для данного модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| changed | проверка, было ли изменение на устройстве | всегда | булево | True |
| end_state | k/v пары параметров aaa после выполнения модуля | всегда | словарь | {'bgp peer': [['192.168.10.10', '500']]} |
| existing | k/v пары существующих параметров aaa сервера | всегда | словарь | {'bgp peer': []} |
| proposed | k/v пары параметров, переданных в модуль | всегда | словарь | {'remote_as': '500', 'state': 'present', 'peer_addr': '192.168.10.10', 'vrf_name': 'js'} |
| updates | команда, отправленная на устройство | всегда | список | ['peer 192.168.10.10 as-number 500'] |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей ознакомьтесь с документацией Информация о сообществе и вклад, Тестирование 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.4/ce_bgp_neighbor_module.html