Модуль dellemc.enterprise_sonic.sonic_poe — управление конфигурацией PoE в 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_poe.

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

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
config dictionary	Задаёт конфигурацию PoE.
cards list / elements=dictionary	Конфигурация карты PoE (аппаратного контроллера питания). В настоящее время не поддерживается на платформах.
auto_reset boolean	Включает режим автоматического сброса PoE для этой карты. Варианты: `false` `true`
card_id integer / обязательный	Идентификатор карты. Должен быть числом в диапазоне от 0 до 7.
power_mgmt_model string	Алгоритм управления питанием. Значение dynamic означает, что энергопотребление каждого порта измеряется и вычисляется в реальном времени. Значение static означает, что мощность, выделяемая для каждого порта, зависит от типа порога мощности, настроенного на порту. Варианты: `"dynamic"` `"dynamic-priority"` `"static"` `"static-priority"` `"class"`
usage_threshold integer	Порог потребления электроэнергии по технологии Inline Power. Диапазон от 0 до 99 включительно.
global dictionary	Конфигурация глобальной карты PoE.
auto_reset boolean	Включает режим автоматического сброса PoE для глобальной конфигурации. В настоящее время не поддерживается на платформах. Варианты: `false` `true`
power_mgmt_model string	Используемый алгоритм управления питанием. Значение dynamic означает, что энергопотребление каждого порта измеряется и вычисляется в реальном времени. Значение static означает, что мощность, выделяемая для каждого порта, зависит от типа порога мощности, настроенного на порту. В настоящее время поддерживаются только значения ‘dynamic’ и ‘class’. Варианты: `"dynamic"` `"dynamic-priority"` `"static"` `"static-priority"` `"class"`
usage_threshold integer	Порог потребления электроэнергии по технологии Inline Power. Диапазон от 0 до 99 включительно. В настоящее время не поддерживается на платформах.
interfaces list / elements=dictionary	Конфигурация PoE для интерфейсов Ethernet.
detection string	Механизм обнаружения устройства, используемый этим портом PSE. Legacy — это схема ёмкостного обнаружения, которую можно использовать отдельно или в качестве резервной, если другие схемы обнаружения не сработают. Другие схемы соответствуют стандартам IEEE 802. Администратор не может принудительно задать значение None. В настоящее время поддерживаются только значения ‘dot3bt’ и ‘dot3bt+legacy’. Варианты: `"2pt-dot3af"` `"2pt-dot3af+legacy"` `"4pt-dot3af"` `"4pt-dot3af+legacy"` `"dot3bt"` `"dot3bt+legacy"` `"legacy"`
disconnect_type string	Тип отключения порта PoE. В настоящее время не поддерживается на платформах. Варианты: `"ac"` `"dc"`
enabled boolean	Включает PoE для порта. Варианты: `false` `true`
four_pair boolean	Включает для порта режим четырёх пар. В настоящее время не поддерживается на платформах. Варианты: `false` `true`
high_power boolean	Включает режим высокой мощности на порту PSE. В настоящее время не поддерживается на платформах. Варианты: `false` `true`
name string / обязательный	Имя интерфейса.
power_classification string	Режим классификации мощности PoE для порта. В настоящее время не поддерживается на платформах. Варианты: `"normal"` `"bypass"`
power_limit integer	Настроенная максимальная мощность, которую этот порт может предоставить подключённому устройству, измеряется в милливаттах. Диапазон от 0 до 99900 включительно. В настоящее время не поддерживается на платформах.
power_limit_type string	Управляет максимальной мощностью, которую может выдавать порт. Значение class-based означает, что ограничение мощности порта определяется классом dot3af подключённого устройства с питанием. Значение user-defined означает, что ограничение задаётся конфигурацией. В настоящее время не поддерживается на платформах. Варианты: `"class-based"` `"user-defined"`
power_pairs string	Настройки пар проводников для питания порта PoE. В настоящее время не поддерживается на платформах. Варианты: `"signal"` `"spare"`
power_up_mode string	Режим подачи высокой мощности, настроенный для порта PSE. Значение pre-dot3at означает, что сначала питание порта осуществляется в режиме IEEE 802.3af, а затем он переключается в режим высокой мощности IEEE 802.3at. Значение dot3at означает, что питание порта осуществляется в режиме IEEE 802.3at. Значения dot3bt, type3 и pre-dot3bt предназначены для поддержки интерфейсов 802.3bt. В настоящее время не поддерживается на платформах. Варианты: `"dot3af"` `"dot3at"` `"dot3bt"` `"dot3bt-type3"` `"dot3bt-type4"` `"high-inrush"` `"pre-dot3at"` `"pre-dot3bt"`
priority string	Приоритет порта PoE в алгоритме управления питанием. Приоритет может использоваться механизмом управления, который предотвращает перегрузку по току, отключая сначала порты с более низким приоритетом питания. В настоящее время поддерживаются только значения ‘low’, ‘high’ и ‘critical’. Варианты: `"low"` `"medium"` `"high"` `"critical"`
use_spare_pair boolean	Включает питание по резервной паре для порта. В настоящее время не поддерживается на платформах. Варианты: `false` `true`
state string	Состояние конфигурации после выполнения модуля. Варианты: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примеры

# Using "merged" state to add or change poe global settings
# Before state:
# config:
#   global:
#     auto_reset: false

# Example:
- name: "add poe global settings"
  sonic_poe:
    config:
      global:
        auto_reset: true
        power_mgmt_model: 'class'
        usage_threshold: 300
    state: merged

# After state:
# config:
#   global:
#     auto_reset: true
#     power_mgmt_model: 'class'
#     usage_threshold: 300
# ------

# Using "merged" state to add cards
# Note that platform must support adding multiple cards to do this
# Before state:
# config:
#   global:
#     auto_reset: true

# Example:
- name: "add poe cards"
  sonic_poe:
    config:
      cards:
        - card_id: 0
          usage_threshold: 39
    state: merged

# After state:
# config:
#   global:
#     auto_reset: true
#   cards:
#     - card_id: 0
#       usage_threshold: 39
# ------

# Using "merged" state to add or change card settings
# Before state:
# config:
#   cards:
#     - card_id: 0
#       usage_threshold: 39

# Example:
- name: "add poe cards settings"
  sonic_poe:
    config:
      cards:
        - card_id: 0
          usage_threshold: 60
          power_mgmt_model: dymanic
    state: merged

# After state:
# config:
#   cards:
#     - card_id: 0
#       usage_threshold: 60
#       power_mgmt_model: dymanic
# ------

# Using "merged" state to add interfaces
# Before state:
# config: {}

# Example:
- name: "add poe interfaces"
  sonic_poe:
    config:
      interfaces:
        - name: Ethernet0
          enabled: true
    state: merged

# After state:
# config:
#   interfaces:
#     - name: Ethernet0
#       enabled: true
# ------

# Using "merged" state to add or change interface settings
# Before state:
# config:
#   interfaces:
#     - name: Ethernet0
#       enabled: true
#       disconnect_type: dc

# Example:
- name: "add poe interface settings"
  sonic_poe:
    config:
      interfaces:
        - name: Ethernet0
          four_pair: true
          high_power: true
          detection: dot3bt
          power_classification: normal
          power_limit: 5000
          power_limit_type: class-based
          power_pairs: signal
          power_up_mode: dot3bt
          priority: medium
          use_spare_pair: false
          disconnect_type: ac
    state: merged

# After state:
# config:
#   interfaces:
#     - name: Ethernet0
#       four_pair: true
#       high_power: true
#       detection: dot3bt
#       power_classification: normal
#       power_limit: 5000
#       power_limit_type: class-based
#       power_pairs: signal
#       power_up_mode: dot3bt
#       priority: medium
#       use_spare_pair: false
#       disconnect_type: ac
#       enabled: true
# ------


# Using "deleted" state to remove poe global settings
# Before state:
# config:
#   global:
#     auto_reset: true
#     power_mgmt_model: 'class'
#     usage_threshold: 300

# Example:
- name: "delete matching poe global settings"
  sonic_poe:
    config:
      global:
        auto_reset: false
        usage_threshold: 300
    state: deleted

# After state:
# config:
#   global:
#     power_mgmt_model: 'class'
#     auto_reset: true
# ------

# Using "deleted" state to delete cards or card settings
# Note: to delete whole card, either need just the name or specify all current settings and values
# Before state:
# config:
#   global:
#     auto_reset: true
#   cards:
#     - card_id: 0
#       usage_threshold: 39
#     - card_id: 1
#       auto_reset: true
#       usage_threshold: 60
#       power_mgmt_model: class
#     - card_id: 2
#       usage_threshold: 39
#       power_mgmt_model: dymanic

# Example:
- name: "delete poe cards"
  sonic_poe:
    config:
      cards:
        - card_id: 0
        - card_id: 1
          auto_reset: true
          usage_threshold: 60
          power_mgmt_model: class
        - card_id: 2
          usage_threshold: 39
          power_mgmt_model: static
    state: deleted

# After state:
# config:
#   global:
#     auto_reset: true
#   cards:
#     - card_id: 2
#       power_mgmt_model: dymanic
# ------

# Using "deleted" state to delete interfaces or interface settings
# Note: to delete whole interface, either need just the name or specify all current settings and values
# Before state:
# config:
#   interfaces:
#     - name: Ethernet0
#       enabled: true
#     - name: Ethernet1
#       enabled: false
#       four_pair: true
#     - name: Ethernet2
#       detection: 4pt-dot3af+legacy
#       power_up_mode: dot3bt
#       use_spare_pair: true

# Example:
- name: "delete poe interfaces"
  sonic_poe:
    config:
      interfaces:
        - name: Ethernet0
        - name: Ethernet1
          enabled: false
          four_pair: true
        - name: Ethernet2
          detection: 4pt-dot3af+legacy
          power_up_mode: pre-dot3at
    state: deleted

# After state:
# config:
#   interfaces:
#     - name: Ethernet2
#       power_up_mode: dot3bt
#       use_spare_pair: true
# ------

# Using "deleted" state to clear all interfaces or cards
# Before state:
# config:
#   cards:
#     - card_id: 0
#       usage_threshold: 39
#   interfaces:
#     - name: Ethernet0
#       enabled: true

# Example:
- name: "clear poe interfaces and cards"
  sonic_poe:
    config:
      interfaces: []
      cards: []
    state: deleted

# After state:
# config: {}
# ------

# Using "deleted" state to delete attributes of interfaces or cards
# Before state:
# config:
#   cards:
#     - card_id: 1
#       auto_reset: true
#       usage_threshold: 60
#   interfaces:
#     - name: Ethernet1
#       enabled: false
#       four_pair: true
#       power_classification: normal

# Example:
- name: "clear poe interfaces and cards"
  sonic_poe:
    config:
      interfaces:
        - name: Ethernet1
          four_pair: true
          cards:
            - card_id: 1
              usage_threshold: 60
    state: deleted

# After state:
# config:
#   interfaces:
#     - name: Ethernet1
#       enabled: false
#       power_classification: normal
#   cards:
#     - card_id: 1
#       auto_reset: true
# ------


# Using "overridden" state to set poe config
# Before state:
# config:
#   global:
#     auto_reset: true
#     power_mgmt_model: 'class'
#     usage_threshold: 300
#   interfaces:
#     - name: Ethernet1
#       power_classification: normal
#       enabled: true
#   cards:
#     - card_id: 0
#       usage_threshold: 60
#       power_mgmt_model: dymanic

# Example:
- name: "overridden to exactly specified"
  sonic_poe:
    config:
      global:
        auto_reset: false
      interfaces:
        - name: Ethernet0
          enabled: true
          disconnect_type: ac
        - name: Ethernet1
          power_pairs: signal
    state: overridden

# After state:
# config:
#   global:
#     auto_reset: false
#   interfaces:
#     - name: Ethernet0
#       disconnect_type: ac
#       enabled: true
#     - name: Ethernet1
#       power_pairs: signal
# ------


# Using "replaced" state to replace sections of poe config
# Before state:
# config:
#   global:
#     auto_reset: true
#     power_mgmt_model: 'class'
#     usage_threshold: 300
#   interfaces:
#     - name: Ethernet1
#       power_classification: normal
#       enabled: true
#     - name: Ethernet0
#       enabled: true
#       power_limit_type: class-based
#   cards:
#     - card_id: 0
#       usage_threshold: 60
#       power_mgmt_model: dymanic

# Example:
- name: "replace sections of config to exactly specified"
  sonic_poe:
    config:
      global:
        auto_reset: false
      interfaces:
        - name: Ethernet0
          enabled: true
          disconnect_type: ac
    state: repalced

# After state:
# config:
#   global:
#     auto_reset: false
#   interfaces:
#     - name: Ethernet0
#       disconnect_type: ac
#       enabled: true
#   cards:
#     - card_id: 0
#       usage_threshold: 60
#       power_mgmt_model: dymanic
# ------

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

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

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

Авторы

1. S. Talabi (@stalabi1), Xiao Han (@Xiao_Han2)

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

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