Модуль dellemc.enterprise_sonic.sonic_system — настройка системных параметров

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
config словарь	Задает конфигурацию, связанную с системой
adjust_txrx_clock_freq логическое значение добавлено в dellemc.enterprise_sonic 3.1.0	Настраивает частоту тактового сигнала TX/RX в соответствии со значением, заданным для платформы. Рабочее значение по умолчанию — `false`. Варианты: `false` `true`
anycast_address словарь	Задает различные типы anycast-адресов, которые можно настроить на устройстве
ipv4 логическое значение	Включает или отключает IPv4 anycast-адрес Варианты: `false` `true`
ipv6 логическое значение	Включает или отключает IPv6 anycast-адрес Варианты: `false` `true`
mac_address строка	Задает MAC anycast-адрес
audit_rules строка добавлено в dellemc.enterprise_sonic 2.5.0	Задает тип профиля правил аудита. Можно использовать в версиях SONiC 4.4.0 и выше. Варианты: `"BASIC"` `"DETAIL"` `"CUSTOM"` `"NONE"`
auto_breakout строка добавлено в dellemc.enterprise_sonic 2.5.0	Задает состояние автоматического разбиения портов на устройстве Варианты: `"ENABLE"` `"DISABLE"`
concurrent_session_limit целое число добавлено в dellemc.enterprise_sonic 3.1.0	Задает ограничение на количество одновременных сеансов Диапазон: 1–12
hostname строка	Задает имя узла устройства SONiC
interface_naming строка	Задает тип именования интерфейсов на устройстве Варианты: `"standard"` `"standard_extended"` `"native"`
load_share_hash_algo строка добавлено в dellemc.enterprise_sonic 2.5.0	Задает тип алгоритма хеширования распределения нагрузки ECMP Варианты: `"CRC"` `"XOR"` `"CRC_32LO"` `"CRC_32HI"` `"CRC_CCITT"` `"CRC_XOR"` `"JENKINS_HASH_LO"` `"JENKINS_HASH_HI"`
password_complexity словарь	Набор параметров конфигурации атрибутов пароля для входа в систему
min_length целое число	Минимальное требуемое количество буквенно-цифровых символов Диапазон: от 6 до 32 Значение по умолчанию — 8
min_lower_case целое число	Минимальное требуемое количество строчных букв Диапазон: от 0 до 31
min_numerals целое число	Минимальное требуемое количество цифр Диапазон: от 0 до 31
min_spl_char целое число	Минимальное требуемое количество специальных символов Диапазон: от 0 до 31
min_upper_case целое число	Минимальное требуемое количество заглавных букв Диапазон: от 0 до 31
switching_mode строка добавлено в dellemc.enterprise_sonic 3.1.0	Задает режим коммутации на устройстве. Рабочее значение по умолчанию — STORE_AND_FORWARD. Варианты: `"CUT_THROUGH"` `"STORE_AND_FORWARD"`
state строка	Задает операцию, выполняемую над системными параметрами, настроенными на устройстве. При значении merged входная конфигурация объединяется с существующей системной конфигурацией устройства. При значении deleted существующая системная конфигурация удаляется с устройства. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"`

Примечания

Примечание

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

Примеры

# Using "deleted" state
#
# Before state:
# -------------
# !
# SONIC(config)#do show running-configuration
# !
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# ip anycast-address enable
# ipv6 anycast-address enable
# interface-naming standard
# ip load-share hash algorithm JENKINS_HASH_HI
# login concurrent-session limit 4
# system adjust-txrx-clock-freq
# login password-attribute character-restriction lower 2

- name: Delete System configuration
  dellemc.enterprise_sonic.sonic_system:
    config:
      hostname: SONIC
      interface_naming: standard
      anycast_address:
        ipv6: true
      load_share_hash_algo: JENKINS_HASH_HI
      concurrent_session_limit: 4
      adjust_txrx_clock_freq: true
      password_complexity:
        min_lower_case: 2
    state: deleted

# After state:
# ------------
# !
# sonic(config)#do show running-configuration
# !
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# ip anycast-address enable


# Using "deleted" state
#
# Before state:
# -------------
# !
# SONIC(config)#do show running-configuration
# !
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# ip anycast-address enable
# ipv6 anycast-address enable
# interface-naming standard
# ip load-share hash algorithm JENKINS_HASH_HI
# login concurrent-session limit 4

- name: Delete all system related configs in device configuration
  dellemc.enterprise_sonic.sonic_system:
    config:
    state: deleted

# After state:
# ------------
# !
# sonic(config)#do show running-configuration
# !


# Using "merged" state
#
# Before state:
# -------------
# !
# sonic(config)#do show running-configuration
# !

- name: Merge provided configuration with device configuration
  dellemc.enterprise_sonic.sonic_system:
    config:
      hostname: SONIC
      interface_naming: standard
      anycast_address:
        ipv6: true
        ipv4: true
        mac_address: aa:bb:cc:dd:ee:ff
      load_share_hash_algo: JENKINS_HASH_HI
      concurrent_session_limit: 4
      adjust_txrx_clock_freq: true
      password_complexity:
        min_upper_case: 2
        min_spl_char: 2
    state: merged

# After state:
# ------------
# !
# SONIC(config)#do show running-configuration
# !
# hostname SONIC
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# ip anycast-address enable
# ipv6 anycast-address enable
# interface-naming standard
# ip load-share hash algorithm JENKINS_HASH_HI
# login concurrent-session limit 4
# system adjust-txrx-clock-freq
# login password-attribute character-restriction upper 2
# login password-attribute character-restriction special-char 2

# Using "replaced" state
#
# Before state:
# -------------
# !
# sonic(config)#do show running-configuration
# !
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# ip anycast-address enable
# ipv6 anycast-address enable
# interface-naming standard
# login concurrent-session limit 4
# login password-attribute character-restriction upper 2
# login password-attribute character-restriction special-char 2

- name: Replace system configuration.
  sonic_system:
    config:
      hostname: SONIC
      anycast_address:
        ipv6: true
      concurrent_session_limit: 5
      password_complexity:
        min_lower_case: 2
    state: replaced

# After state:
# ------------
# !
# SONIC(config)#do show running-configuration
# !
# hostname SONIC
# ipv6 anycast-address enable
# login concurrent-session limit 5
# login password-attribute character-restriction lower 2

# Using "replaced" state
#
# Before state:
# -------------
# !
# sonic(config)#do show running-configuration
# !
# ip anycast-mac-address aa:bb:cc:dd:ee:ff
# interface-naming standard
# login concurrent-session limit 5
# login password-attribute character-restriction lower 2

- name: Replace system device configuration.
  sonic_system:
    config:
      hostname: sonic
      interface_naming: standard
      anycast_address:
        ipv6: true
        ipv4: true
      load_share_hash_algo: JENKINS_HASH_HI
      password_complexity:
        min_numerals: 2
    state: replaced

# After state:
# ------------
# !
# sonic(config)#do show running-configuration
# !
# ip anycast-address enable
# ipv6 anycast-address enable
# interface-naming standard
# ip load-share hash algorithm JENKINS_HASH_HI
# login password-attribute character-restriction numeric 2

# Using "overridden" state
#
# Before state:
# -------------
# !
# sonic(config)#do show running-configuration
# !
# ipv6 anycast-address enable
# ip load-share hash algorithm JENKINS_HASH_HI
# login concurrent-session limit 5
# login password-attribute character-restriction numeric 2

- name: Override system configuration.
  sonic_system:
    config:
      hostname: SONIC
      interface_naming: standard
      anycast_address:
        ipv4: true
        mac_address: bb:aa:cc:dd:ee:ff
      load_share_hash_algo: CRC_XOR
      concurrent_session_limit: 4
      password_complexity:
        min_upper_case: 1
    state: overridden

# After state:
# ------------
# !
# SONIC(config)#do show running-configuration
# !
# hostname SONIC
# ip anycast-mac-address bb:aa:cc:dd:ee:ff
# ip anycast-address enable
# interface-naming standard
# ip load-share hash algorithm CRC_XOR
# login concurrent-session limit 4
# login password-attribute character-restriction upper 1

# Using "merged" state
#
# Before state:
# -------------
# !
# sonic(config)#do show running-configuration
# !

- name: Merge provided configuration with device configuration
  dellemc.enterprise_sonic.sonic_system:
    config:
      hostname: SONIC
      interface_naming: standard
      auto_breakout: ENABLE
      load_share_hash_algo: JENKINS_HASH_HI
      audit_rules: BASIC
    state: merged

# After state:
# ------------
# !
# SONIC(config)#do show running-configuration
# !
# hostname SONIC
# interface-naming standard
# auto-breakout
# ip load-share hash algorithm JENKINS_HASH_HI
# auditd-system rules basic

# Using "deleted" state
#
# Before state:
# -------------
# !
# SONIC(config)#do show running-configuration
# !
# hostname SONIC
# interface-naming standard
# auto-breakout
# ip load-share hash algorithm JENKINS_HASH_HI
# auditd-system rules basic

- name: Delete auto-breakout configuration on the device
  dellemc.enterprise_sonic.sonic_system:
    config:
      hostname: SONIC
      auto_breakout: ENABLE
      load_share_hash_algo: JENKINS_HASH_HI
      audit_rules: BASIC
    state: deleted

# After state:
# ------------
# !
# sonic(config)#do show running-configuration
# !
# interface-naming standard

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

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

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

Авторы

Abirami N (@abirami-n)

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

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