Spec-Zone.ru › Ansible

Модуль dellemc.enterprise_sonic.sonic_pms — настройка параметров безопасности портов в режиме интерфейса на SONiC.

Примечание

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

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

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

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

Новое в dellemc.enterprise_sonic 3.1.0

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

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

  • Этот модуль управляет конфигурацией параметров безопасности портов для интерфейсов на устройствах под управлением SONiC.
  • Перед настройкой безопасности портов на интерфейсах настройте switchport.

Параметры

Параметр

Комментарии

config

list / elements=dictionary

Задает конфигурацию безопасности портов для интерфейсов.

max_allowed_macs

integer

Максимальное количество защищенных MAC-адресов, разрешенных на интерфейсе. (от 1 до 4097)

Если port_security_enable=True, а параметр max_allowed_macs не задан, используется значение по умолчанию 1.

name

string / обязательный

Полное имя интерфейса, например Ethernet1.

port_security_enable

boolean / обязательный

Включает безопасность портов на уровне интерфейса.

Если port_security_enable=False, вся конфигурация безопасности портов будет удалена.

Допустимые значения:

  • false
  • true

sticky_mac

boolean

Включает функцию Sticky MAC на интерфейсе.

Если port_security_enable=True, а параметр sticky_mac не задан, используется значение по умолчанию False.

Допустимые значения:

  • false
  • true

violation

string

Задает действие, выполняемое при нарушении безопасности.

SHUTDOWN — отключить интерфейс.

PROTECT — отбрасывать пакеты, полученные интерфейсом.

Если port_security_enable=True, а параметр violation не задан, используется значение по умолчанию PROTECT.

Допустимые значения:

  • "SHUTDOWN"
  • "PROTECT"

state

string

Задает операцию, которая будет выполнена с настроенными на устройстве интерфейсами, относящимися к безопасности портов.

При значении merged входная конфигурация будет объединена с существующей на устройстве конфигурацией интерфейсов, относящихся к безопасности портов.

При значении deleted существующая конфигурация интерфейсов OSPFv2 будет удалена с устройства.

При значении overridden вся существующая конфигурация интерфейсов OSPFv2 будет удалена, а указанная входная конфигурация будет установлена.

При значении replaced существующая конфигурация интерфейса на устройстве будет заменена конфигурацией из плейбука для каждой группы интерфейсов, настроенной в плейбуке.

Допустимые значения:

  • "merged" ← (по умолчанию)
  • "deleted"
  • "replaced"
  • "overridden"

Примечания

Примечание

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

Примеры

# Using "deleted" state

# Before state:
# -------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            1               0           0                 PROTECT         N
#     Ethernet10          N            1               0           0                 PROTECT         Y
# sonic#

- name: Delete the PMS configurations
  sonic_pms:
    config:
      - name: 'Ethernet0'
        port_security_enable: true
      - name: 'Ethernet10'
        port_security_enable: false
        sticky_mac: true
    state: deleted

# After state:
# ------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet10          N            1               0           0                 PROTECT         N
# sonic#


# Using "deleted" state

# Before state:
# -------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            1               0           0                 PROTECT         N
#     Ethernet3           Y            10              0           0                 PROTECT         N
#     Ethernet4           N            15              0           0                 SHUTDOWN        N
#     Ethernet5           Y            30              0           0                 SHUTDOWN        N
#     Ethernet10          N            1               0           0                 PROTECT         Y
# sonic#

- name: Delete all the PMS configurations
  sonic_pms:
    config: []
    state: deleted

# After state:
# ------------
#
# sonic# show port-security
# sonic#


# Using "merged" state

# Before state:
# -------------
#
# sonic# show port-security
# sonic#

- name: Add the PMS configurations new to interfaces
  sonic_pms:
    config:
      - name: 'Ethernet0'
        sticky_mac: true
        port_security_enable: true
        max_allowed_macs: 10
      - name: 'Ethernet3'
        port_security_enable: false
        max_allowed_macs: 10
      - name: 'Ethernet4'
        port_security_enable: true
        violation: SHUTDOWN
    state: merged

# After state:
# ------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            10              0           0                 PROTECT         Y
#     Ethernet3           N            10              0           0                 PROTECT         N
#     Ethernet4           Y            1               0           0                 SHUTDOWN        N
# sonic#


# Using "merged" state

# Before state:
# -------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            10              0           0                 PROTECT         Y
#     Ethernet3           N            10              0           0                 PROTECT         N
#     Ethernet4           Y            1               0           0                 SHUTDOWN        N
# sonic#

- name: Disable a PMS interface by merge
  sonic_pms:
    config:
      - name: 'Ethernet10'
        port_security_enable: false
        max_allowed_macs: 12
        violation: SHUTDOWN
        sticky_mac: true
      - name: 'Ethernet4'
        port_security_enable: false
    state: merged

# After state:
# ------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            10              0           0                 PROTECT         Y
#     Ethernet3           N            10              0           0                 PROTECT         N
#     Ethernet10          N            12              0           0                 SHUTDOWN        Y
# sonic#


# Using "replaced" state

# Before state:
# -------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            1               0           0                 PROTECT         N
#     Ethernet3           Y            10              0           0                 PROTECT         N
#     Ethernet4           N            15              0           0                 SHUTDOWN        N
#     Ethernet5           Y            30              0           0                 SHUTDOWN        N
#     Ethernet10          N            12              0           0                 SHUTDOWN        Y
# sonic#

- name: Replace the PMS configurations by interface level
  sonic_pms:
    config:
      - name: 'Ethernet10'
        port_security_enable: true
      - name: 'Ethernet3'
        port_security_enable: false
        violation: 'PROTECT'
        sticky_mac: true
      - name: 'Ethernet7'
        port_security_enable: true
    state: replaced

# After state:
# ------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            1               0           0                 PROTECT         N
#     Ethernet3           N            10              0           0                 PROTECT         Y
#     Ethernet4           N            15              0           0                 SHUTDOWN        N
#     Ethernet5           Y            30              0           0                 SHUTDOWN        N
#     Ethernet7           Y            1               0           0                 PROTECT         N
#     Ethernet10          Y            1               0           0                 PROTECT         N
# sonic#


# Using "overridden" state

# Before state:
# -------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet0           Y            1               0           0                 PROTECT         N
#     Ethernet3           Y            10              0           0                 PROTECT         N
#     Ethernet4           N            15              0           0                 SHUTDOWN        N
#     Ethernet5           Y            30              0           0                 SHUTDOWN        N
#     Ethernet10          N            12              0           0                 SHUTDOWN        Y
# sonic#

- name: Override the PMS configurations
  sonic_pms:
    config:
      - name: 'Ethernet7'
        port_security_enable: true
      - name: 'Ethernet10'
        port_security_enable: false
        max_allowed_macs: 12
        violation: SHUTDOWN
        sticky_mac: true
    state: overridden

# After state:
# ------------
#
# sonic# show port-security
#
# Secure Port         isEnabled    MaxSecureAddr   FdbCount    ViolationCount    SecurityAction  StickyMac
# ---------------------------------------------------------------------------------------------------------
#     Ethernet7           Y            1               0           0                 PROTECT         N
#     Ethernet10          N            12              0           0                 SHUTDOWN        Y
# sonic#

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

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

Ключ

Описание

after

list / elements=string

Конфигурация, полученная в результате выполнения модуля.

Возвращается: при изменении

Пример: ["The configuration returned will always be in the same format\n of the parameters above.\n"]

after(generated)

list / elements=string

Конфигурация, которая была бы создана при выполнении модуля вне режима проверки.

Возвращается: когда check_mode

Пример: ["The configuration returned will always be in the same format\n of the parameters above.\n"]

before

list / elements=string

Конфигурация до выполнения модуля.

Возвращается: всегда

Пример: ["The configuration returned will always be in the same format\n of the parameters above.\n"]

commands

list / elements=string

Список команд, отправленных на удаленное устройство.

Возвращается: всегда

Пример: ["command 1", "command 2", "command 3"]

Авторы

  • Santhosh kumar T (@santhosh-kt)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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_pms_module.html

Spec-Zone.ru

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