Модуль community.network.cnos_bgp – Управление ресурсами и атрибутами BGP на устройствах с CNOS

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в плейбуке, укажите: community.network.cnos_bgp.

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

Обзор

Этот модуль позволяет работать с конфигурациями протокола BGP (Border Gateway Protocol). Операторы перегружены для обеспечения контроля над конфигурациями BGP на коммутаторах. Этот модуль вызывается с помощью метода, у которого asNumber является одним из аргументов. Первый уровень конфигурации BGP позволяет настроить номер AS, а последующие атрибуты используются в различных операциях конфигурации в контексте BGP. После прохождения этого уровня есть восемь аргументов BGP, которые будут выполнять дальнейшие конфигурации: bgpArg1, bgpArg2, bgpArg3, bgpArg4, bgpArg5, bgpArg6, bgpArg7 и bgpArg8. Более подробную информацию о том, как использовать эти аргументы, см. в [Перегруженные переменные]. Этот модуль использует SSH для управления конфигурацией сетевых устройств. Результаты операции будут помещены в директорию с именем «results», которую пользователь должен создать в локальном каталоге, где выполняется плейбук.

Псевдонимы: network.cnos.cnos_bgp

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
asNum string / required	Номер AS
bgpArg1 string / required	Это перегруженный первый аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"address-family"` `"bestpath"` `"bgp"` `"cluster-id"` `"confederation"` `"enforce-first-as"` `"fast-external-failover"` `"graceful-restart"` `"graceful-restart-helper"` `"log-neighbor-changes"` `"maxas-limit"` `"neighbor"` `"router-id"` `"shutdown"` `"synchronization"` `"timers"` `"vrf"`
bgpArg2 string	Это перегруженный второй аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"ipv4 or ipv6"` `"always-compare-med"` `"compare-confed-aspath"` `"compare-routerid"` `"dont-compare-originator-id"` `"tie-break-on-age"` `"as-path"` `"med"` `"identifier"` `"peers"`
bgpArg3 string	Это перегруженный третий аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"aggregate-address"` `"client-to-client"` `"dampening"` `"distance"` `"maximum-paths"` `"network"` `"nexthop"` `"redistribute"` `"save"` `"synchronization"` `"ignore or multipath-relax"` `"confed or missing-as-worst or non-deterministic or remove-recv-med or remove-send-med"`
bgpArg4 string	Это перегруженный четвертый аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"Aggregate prefix"` `"Reachability Half-life time"` `"route-map"` `"Distance for routes ext"` `"ebgp or ibgp"` `"IP prefix <network>"` `"IP prefix <network>/<length>"` `"synchronization"` `"Delay value"` `"direct"` `"ospf"` `"static"` `"memory"`
bgpArg5 string	Это перегруженный пятый аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"as-set"` `"summary-only"` `"Value to start reusing a route"` `"Distance for routes internal"` `"Supported multipath numbers"` `"backdoor"` `"map"` `"route-map"`
bgpArg6 string	Это перегруженный шестой аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"summary-only"` `"as-set"` `"route-map name"` `"Value to start suppressing a route"` `"Distance local routes"` `"Network mask"` `"Pointer to route-map entries"`
bgpArg7 string	Это перегруженный седьмой аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"Maximum duration to suppress a stable route(minutes)"` `"backdoor"` `"route-map"` `"Name of the route map"`
bgpArg8 string	Это перегруженный восьмой аргумент bgp. Использование этого аргумента можно найти в руководстве пользователя, ссылка на которое приведена выше. Варианты: `"Un-reachability Half-life time for the penalty(minutes)"` `"backdoor"`
deviceType string / required	Указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены начиная с Ansible 2.4. Вариант NE0152T добавлен начиная с 2.8 Варианты: `"g8272_cnos"` `"g8296_cnos"` `"g8332_cnos"` `"NE0152T"` `"NE1072T"` `"NE1032"` `"NE1032T"` `"NE10032"` `"NE2572"`
enablePassword string	Настраивает пароль, используемый для входа в режим команд глобальной конфигурации на коммутаторе. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр является необязательным. Если он не указан, значение по умолчанию не будет использоваться.
host string / required	Это переменная, используемая для поиска файла hosts в /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применен шаблон. Обычно ключевое слово Ansible {{ inventory_hostname }} указывается в playbook как абстракция группы сетевых элементов, которые необходимо настроить.
outputfile string / required	Указывает путь к файлу, в котором сохраняется результат выполнения каждой команды. Здесь сохраняются все команды, указанные в объединенном файле шаблона, и каждый ответ от устройства. Обычно это папка результатов, но вы можете выбрать другое местоположение в зависимости от ваших прав на запись.
password string / required	Настраивает пароль, используемый для аутентификации соединения с удаленным устройством. Значение параметра password используется для аутентификации сессии SSH. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр является необязательным. Если он не указан, значение по умолчанию не будет использоваться.

username

строка / обязательно

Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Значение параметра username используется для аутентификации сессии SSH. Хотя, как правило, это значение должно быть взято из файла инвентаризации, его также можно указать в качестве переменной. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Lenovo Network см. на странице https://www.ansible.com/ansible-lenovo.

Примеры

Tasks: The following are examples of using the module cnos_bgp. These are
 written in the main.yml file of the tasks directory.
---
- name: Test BGP  - neighbor
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "neighbor"
      bgpArg2: "10.241.107.40"
      bgpArg3: 13
      bgpArg4: "address-family"
      bgpArg5: "ipv4"
      bgpArg6: "next-hop-self"

- name: Test BGP  - BFD
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "neighbor"
      bgpArg2: "10.241.107.40"
      bgpArg3: 13
      bgpArg4: "bfd"

- name: Test BGP  - address-family - dampening
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "address-family"
      bgpArg2: "ipv4"
      bgpArg3: "dampening"
      bgpArg4: 13
      bgpArg5: 233
      bgpArg6: 333
      bgpArg7: 15
      bgpArg8: 33

- name: Test BGP  - address-family - network
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "address-family"
      bgpArg2: "ipv4"
      bgpArg3: "network"
      bgpArg4: "1.2.3.4/5"
      bgpArg5: "backdoor"

- name: Test BGP - bestpath - always-compare-med
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "bestpath"
      bgpArg2: "always-compare-med"

- name: Test BGP - bestpath-compare-confed-aspat
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "bestpath"
      bgpArg2: "compare-confed-aspath"

- name: Test BGP - bgp
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "bgp"
      bgpArg2: 33

- name: Test BGP  - cluster-id
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "cluster-id"
      bgpArg2: "1.2.3.4"

- name: Test BGP - confederation-identifier
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "confederation"
      bgpArg2: "identifier"
      bgpArg3: 333

- name: Test BGP - enforce-first-as
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "enforce-first-as"

- name: Test BGP - fast-external-failover
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "fast-external-failover"

- name: Test BGP  - graceful-restart
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "graceful-restart"
      bgpArg2: 333

- name: Test BGP - graceful-restart-helper
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "graceful-restart-helper"

- name: Test BGP - maxas-limit
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "maxas-limit"
      bgpArg2: 333

- name: Test BGP  - neighbor
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "neighbor"
      bgpArg2: "10.241.107.40"
      bgpArg3: 13
      bgpArg4: "address-family"
      bgpArg5: "ipv4"
      bgpArg6: "next-hop-self"

- name: Test BGP - router-id
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "router-id"
      bgpArg2: "1.2.3.4"

- name: Test BGP - synchronization
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "synchronization"

- name: Test BGP - timers
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "timers"
      bgpArg2: 333
      bgpArg3: 3333

- name: Test BGP - vrf
  community.network.cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "vrf"

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
msg строка	Сообщение об успехе или ошибке. При любой ошибке метод возвращает строку с сообщением об ошибке. Возвращается: всегда

Авторы

Anil Kumar Muraleedharan (@amuraleedhar)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/cnos_bgp_module.html