модуль dellemc.enterprise_sonic.sonic_bgp_communities — управление сообществом BGP и его параметрами

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

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

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

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_bgp_communities.

Добавлено в dellemc.enterprise_sonic 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль управляет конфигурацией bgp_communities BGP на устройствах под управлением Enterprise SONiC Distribution by Dell Technologies.

Параметры

Параметр	Комментарии
config list / elements=dictionary	Список конфигураций ‘bgp_communities’.
local_as boolean	Не отправлять за пределы локальной AS (общеизвестное сообщество); применимо для стандартного типа сообщества BGP. Варианты: `false` `true`
match string	Соответствует любому элементу или всем элементам. Если не указано, значение по умолчанию для работы — `ANY`. Варианты: `"ALL"` `"ANY"`
members dictionary	Элементы этого списка сообществ BGP.
aann list / elements=string добавлено в dellemc.enterprise_sonic 3.0.0	Номер сообщества в формате aa:nn, 0..65535:0..65535; применимо для стандартного типа сообщества BGP.
regex list / elements=string	Элементы этого списка сообществ BGP. Здесь можно указать строку регулярного выражения. Применимо для расширенного типа сообщества BGP.
name string / обязательный	Имя списка сообществ BGP.
no_advertise boolean	Не анонсировать ни одному узлу-соседу (общеизвестное сообщество); применимо для стандартного типа сообщества BGP. Варианты: `false` `true`
no_export boolean	Не экспортировать в следующую AS (общеизвестное сообщество); применимо для стандартного типа сообщества BGP. Варианты: `false` `true`
no_peer boolean	Не экспортировать в следующую AS (общеизвестное сообщество); применимо для стандартного типа сообщества BGP. Варианты: `false` `true`
permit boolean	Разрешает или запрещает это сообщество. Если не указано, значение по умолчанию для работы — `False`. Варианты: `false` `true`
type string	Определяет, является ли запись списка сообществ стандартной или расширенной. Если не указано, значение по умолчанию для работы — `standard`. Варианты: `"standard"` `"expanded"`
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примечания

Примечание

Проверено на Enterprise SONiC Distribution by Dell Technologies.
Поддерживает check_mode.

Примеры

# Using "deleted" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Delete a BGP community-list member
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test1
        type: expanded
        permit: false
        members:
          regex:
            - 302
    state: deleted

# After state:
# ------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101


# Using "deleted" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Delete a single BGP community-list
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test
        type: standard
    state: deleted

# After state:
# ------------
#
# show bgp community-list
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302


# Using "deleted" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Delete All BGP community-lists
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
    state: deleted

# After state:
# ------------
#
# show bgp community-list
#


# Using "deleted" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Delete all members in a single BGP community-list
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test1
        type: expanded
        members:
          regex:
    state: deleted

# After state:
# ------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer


# Using "merged" state

# Before state:
# -------------
#
# show bgp community-list
# Expanded community list test1:   match: ANY
#     permit 101
#     permit 302

- name: Add new BGP community-lists
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test2
        type: expanded
        permit: true
        members:
          regex:
            - 909
      - name: test3
        type: standard
        permit: true
        no_peer: true
        members:
          aann:
            - 1000:10
    state: merged

# After state:
# ------------
#
# show bgp community-list
# Expanded community list test1:   match: ANY
#     permit 101
#     permit 302
# Expanded community list test2:   match: ANY
#     permit 909
# Standard community list test3:  match: ANY
#     permit 1000:10
#     permit no-peer


# Using "replaced" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Replacing a single BGP community-list
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test
        type: expanded
        members:
          regex:
            - 301
      - name: test2
        type: standard
        members:
          aann:
            - 1000:10
            - 2000:20
      - name: test3
        type: standard
        no_advertise: true
        no_peer: true
        permit: false
        match: ALL
    state: replaced

# After state:
# ------------
#
# show bgp community-list
# Expanded community list test:   match: ANY
#     deny 301
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302
# Standard community list test2:  match: ANY
#     deny 1000:10
#     deny 2000:10
# Standard community list test3:  match: ALL
#     deny no-advertise
#     deny no-peer


# Using "overridden" state

# Before state:
# -------------
#
# show bgp community-list
# Standard community list test:  match: ANY
#     permit local-as
#     permit no-peer
# Expanded community list test1:   match: ANY
#     deny 101
#     deny 302

- name: Override entire BGP community-lists
  dellemc.enterprise_sonic.sonic_bgp_communities:
    config:
      - name: test3
        type: expanded
        members:
          regex:
            - 301
    state: overridden

# After state:
# ------------
#
# show bgp community-list
# Expanded community list test3:   match: ANY
#     deny 301
#

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

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

Ключ	Описание
after list / elements=string	Результирующая конфигурация после вызова модуля. Возвращается: при изменении Пример: `["The configuration that is returned is always in the same format as the parameters above.\n"]`
before list / elements=string	Конфигурация до вызова модуля. Возвращается: всегда Пример: `["The configuration that is returned is always in the same format as the parameters above.\n"]`
commands list / elements=string	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

Kumaraguru Narayanan (@nkumaraguru)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_bgp_communities_module.html