Spec-Zone.ru › Ansible 2.9

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

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
asNum
- / обязательно
Значение по умолчанию:
null
Номер AS
bgpArg1
- / обязательно
    Варианты:
  • 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
Значение по умолчанию:
null
Это перегруженный первый аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg2
-
    Варианты:
  • ipv4 or ipv6
  • always-compare-med
  • compare-confed-aspath
  • compare-routerid
  • dont-compare-originator-id
  • tie-break-on-age
  • as-path
  • med
  • identifier
  • peers
Значение по умолчанию:
null
Это перегруженный второй аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg3
-
    Варианты:
  • 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
Значение по умолчанию:
null
Это перегруженный третий аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg4
-
    Варианты:
  • 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
Значение по умолчанию:
null
Это перегруженный четвертый аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg5
-
    Варианты:
  • as-set
  • summary-only
  • Value to start reusing a route
  • Distance for routes internal
  • Supported multipath numbers
  • backdoor
  • map
  • route-map
Значение по умолчанию:
null
Это перегруженный пятый аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg6
-
    Варианты:
  • summary-only
  • as-set
  • route-map name
  • Value to start suppressing a route
  • Distance local routes
  • Network mask
  • Pointer to route-map entries
Значение по умолчанию:
null
Это перегруженный шестой аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg7
-
    Варианты:
  • Maximum duration to suppress a stable route(minutes)
  • backdoor
  • route-map
  • Name of the route map
Значение по умолчанию:
null
Это перегруженный седьмой аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
bgpArg8
-
    Варианты:
  • Un-reachability Half-life time for the penalty(minutes)
  • backdoor
Значение по умолчанию:
null
Это перегруженный восьмой аргумент bgp. Использование этого аргумента можно найти в Руководстве пользователя, упомянутом выше.
deviceType
строка / обязательно
    Варианты:
  • g8272_cnos
  • g8296_cnos
  • g8332_cnos
  • NE0152T
  • NE1072T
  • NE1032
  • NE1032T
  • NE10032
  • NE2572
Это указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены, начиная с Ansible 2.4. Вариант NE0152T добавлен, начиная с 2.8
enablePassword
строка
Конфигурирует пароль, используемый для входа в режим команд глобальной конфигурации на коммутаторе. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию использоваться не будет.
host
строка / обязательно
Это переменная, используемая для поиска файла hosts в /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применен шаблон. Обычно ключевое слово Ansible {{ inventory_hostname }} указывается в playbook как абстракция группы сетевых элементов, которые необходимо настроить.
outputfile
строка / обязательно
Это указывает путь к файлу, в котором сохраняется результат каждого выполнения команды. Каждая команда, указанная в объединенном файле шаблона, и каждый ответ от устройства сохраняются здесь. Обычно это папка results, но вы можете выбрать другое местоположение в зависимости от ваших прав на запись.
password
строка / обязательно
Конфигурирует пароль, используемый для аутентификации подключения к удаленному устройству. Значение параметра password используется для аутентификации сеанса SSH. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию использоваться не будет.
username
строка / обязательно
Конфигурирует имя пользователя, используемое для аутентификации подключения к удаленному устройству. Значение параметра username используется для аутентификации сеанса SSH. Хотя обычно значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязательный. Если он не указан, значение по умолчанию использоваться не будет.

Примечания

Примечание

  • Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами Lenovo см. 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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  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
  cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "synchronization"

- name: Test BGP - timers
  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
  cnos_bgp:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_bgp_{{ inventory_hostname }}_output.txt"
      asNum: 33
      bgpArg1: "vrf"

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

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

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



Статус

  • Совместимость интерфейса этого модуля с предыдущими версиями не гарантируется. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Anil Kumar Muraleedharan (@amuraleedhar)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cnos_bgp_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API