Модуль dellemc.enterprise_sonic.sonic_poe – Управление конфигурацией PoE на SONiC

Примечание

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

Вы, возможно, уже установили эту коллекцию, если используете пакет 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 / required	Идентификатор карты. должно быть число в диапазоне 0-7.
power_mgmt_model string	алгоритм управления питанием. dynamic означает, что потребление энергии каждого порта измеряется и вычисляется в реальном времени. static означает, что мощность, выделяемая для каждого порта, зависит от типа порогового значения мощности, настроенного на порту Варианты: `"dynamic"` `"dynamic-priority"` `"static"` `"static-priority"` `"class"`
usage_threshold integer	Пороговое значение потребления встроенной мощности. Диапазон от 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	Пороговое значение потребления встроенной мощности. Диапазон от 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 / required	Имя интерфейса
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"` `"medium"` `"high"` `"critical"`
use_spare_pair boolean	Включает резервную пару для питания порта. В настоящее время не поддерживается на платформах. Выбираемые значения: `false` `true`
state string	Состояние конфигурации после завершения модуля. Выбираемые значения: `"merged"` ← (по умолчанию) `"deleted"` `"replaced"` `"overridden"`

Примеры

# Using merged 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 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 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 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 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 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 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 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 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 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 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 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"]`

Авторы

Shade Talabi (@stalabi1), Xiao Han (@Xiao_Han2)

Ссылки на сборку

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