Модуль dellemc.enterprise_sonic.sonic_vlans – управление VLAN и его параметрами

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

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

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

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

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

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

Параметры

Параметр	Комментарии
config list / elements=dictionary	Словарь параметров VLAN.
autostate boolean добавлено в dellemc.enterprise_sonic 3.1.0	Включение или отключение функции autostate для интерфейса VLAN. Если для этого поля ещё не задано значение, по умолчанию используется «enable», что соответствует значению true. Возможные значения: `false` `true`
description string	Описание VLAN.
vlan_id integer / обязательный	Идентификатор VLAN Диапазон: от 1 до 4094
state string	Состояние, в котором должна остаться конфигурация. Возможные значения: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"`

Примечания

Примечание

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

Примеры

# Using "merged" state

# Before state:
# -------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 30         Inactive
#
# sonic#
#


- name: Merges given VLAN attributes with the device configuration
  dellemc.enterprise_sonic.sonic_vlans:
    config:
      - vlan_id: 10
        description: "Internal"
    state: merged

# After state:
# ------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 30         Inactive
#
# sonic#
#
# sonic# show interface Vlan 10
# Description: Internal
# Vlan10 is up
# Mode of IPV4 address assignment: not-set
# Mode of IPV6 address assignment: not-set
# IP MTU 6000 bytes
# sonic#
#

# Using "replaced" state

# Before state:
# -------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 30         Inactive
#
# sonic#

- name: Replace all attributes of specified VLANs with provided configuration
  dellemc.enterprise_sonic.sonic_vlans:
    config:
      - vlan_id: 10
    state: replaced

# After state:
# ------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 30         Inactive
#
# sonic#

# Using "overridden" state

# Before state:
# -------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 30         Inactive
#
# sonic#

- name: Override device configuration of all VLANs with provided configuration
  dellemc.enterprise_sonic.sonic_vlans:
    config:
      - vlan_id: 10
    state: overridden

# After state:
# ------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
#
# sonic#

# Using "deleted" state

# Before state:
# -------------
#
# sonic# show interface Vlan 70
# Description: Internal
# Vlan70 is up
# Mode of IPV4 address assignment: not-set
# Mode of IPV6 address assignment: not-set
# IP MTU 6000 bytes

- name: Deletes attributes of the given VLANs
  dellemc.enterprise_sonic.sonic_vlans:
    config:
      - vlan_id: 70
        description: "Internal"
    state: deleted

# After state:
# ------------
#
# sonic# show interface Vlan 70
# Vlan70 is up
# Mode of IPV4 address assignment: not-set
# Mode of IPV6 address assignment: not-set
# IP MTU 6000 bytes

# Before state:
# -------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 20         Inactive
#
# sonic#

- name: Deletes attributes of the given VLANs
  dellemc.enterprise_sonic.sonic_vlans:
    config:
      - vlan_id: 20
    state: deleted

# After state:
# ------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
#
# sonic#


# Using "deleted" state

# Before state:
# -------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
# 10         Inactive
# 20         Inactive
# 30         Inactive
#
# sonic#

- name: Deletes all the VLANs on the switch
  dellemc.enterprise_sonic.sonic_vlans:
    config:
    state: deleted

# After state:
# ------------
#
# sonic# show Vlan
# Q: A - Access (Untagged), T - Tagged
# NUM        Status      Q Ports
#
# sonic#

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

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

Ключ	Описание
after list / elements=string	Конфигурация, полученная в результате вызова модуля. Возвращается: при изменении Пример: `["The configuration 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"]`

Авторы

Mohamed Javeed (@javeedf)

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

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