Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_device_local_access_configuration — настройка параметров локального доступа в OpenManage Enterprise Modular.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.ome_device_local_access_configuration.

Добавлено в dellemc.openmanage 4.4.0

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

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

  • Этот модуль позволяет настраивать параметры локального доступа к кнопке питания, Quick Sync, KVM, ЖК-дисплею и прямого доступа к шасси в OpenManage Enterprise Modular.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

path

добавлено в dellemc.openmanage 5.0.0

Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.

chassis_power_button

dictionary

Параметры кнопки питания шасси.

disabled_button_lcd_override_pin

string

Шестизначный PIN-код переопределения ЖК-дисплея для изменения состояния питания шасси.

Это значение необходимо, если enable_lcd_override_pin равно true.

Модуль всегда будет сообщать об изменении, если disabled_button_lcd_override_pin равно true.

Значение необходимо указывать в кавычках. Например: “001100”.

enable_chassis_power_button

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

Включает или отключает кнопку питания шасси.

Если false, включить или выключить шасси с помощью кнопки питания нельзя.

Варианты:

  • false
  • true

enable_lcd_override_pin

boolean

Включает или отключает PIN-код переопределения ЖК-дисплея.

Это значение необходимо, если enable_chassis_power_button равно false.

Варианты:

  • false
  • true

device_id

integer

Идентификатор шасси, для которого необходимо обновить конфигурацию локального доступа.

Если идентификатор устройства не указан, этот модуль обновляет параметры локального доступа для hostname.

device_id и device_service_tag являются взаимоисключающими параметрами.

device_service_tag

string

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

Если сервисный тег устройства не указан, этот модуль обновляет параметры локального доступа для hostname.

device_service_tag и device_id являются взаимоисключающими параметрами.

enable_chassis_direct_access

boolean

Включает или отключает доступ к консолям управления, таким как iDRAC и модуль управления устройства, на шасси.

Варианты:

  • false
  • true

enable_kvm_access

boolean

Включает или отключает интерфейсы клавиатуры, видео и мыши (KVM).

Варианты:

  • false
  • true

hostname

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

IP-адрес или имя узла OpenManage Enterprise Modular.

lcd

dictionary

Параметры ЖК-дисплея.

Параметры lcd игнорируются, если в шасси отсутствует оборудование ЖК-дисплея.

lcd_access

string

Параметр настройки Quick Sync с помощью ЖК-дисплея.

VIEW_AND_MODIFY — установить уровень доступа для просмотра и изменения.

VIEW_ONLY — установить уровень доступа только для просмотра.

DISABLED — отключить доступ.

Варианты:

  • "VIEW_AND_MODIFY"
  • "VIEW_ONLY"
  • "DISABLED"

lcd_language

string

Код языка, на котором должен отображаться текст на ЖК-дисплее.

en — английский язык.

fr — французский язык.

de — немецкий язык.

es — испанский язык.

ja — японский язык.

zh — китайский язык.

user_defined

string

Текст для отображения на главном экране ЖК-дисплея. Главный экран ЖК-дисплея отображается после сброса системы до заводских настроек. Длина пользовательского текста не должна превышать 62 символов.

password

string

Пароль OpenManage Enterprise Modular.

Если пароль не указан, используется переменная среды OME_PASSWORD.

Пример: export OME_PASSWORD=password

port

integer

HTTPS-порт OpenManage Enterprise Modular.

По умолчанию: 443

quick_sync

dictionary

Параметры Quick Sync.

Параметры quick_sync игнорируются, если оборудование Quick Sync отсутствует.

enable_inactivity_timeout

boolean

Включает или отключает тайм-аут бездействия.

Варианты:

  • false
  • true

enable_quick_sync_wifi

boolean

Включает или отключает канал связи Wi-Fi с шасси.

Варианты:

  • false
  • true

enable_read_authentication

boolean

Включает или отключает возможность входа с использованием учетных данных пользователя и чтения инвентарных данных в защищенном центре обработки данных.

Варианты:

  • false
  • true

quick_sync_access

string

Пользователи с правами администратора могут задать следующие типы параметра quick_sync_access.

READ_WRITE позволяет записывать конфигурацию с помощью Quick Sync.

READ_ONLY предоставляет доступ только для чтения по Wi-Fi и Bluetooth Low Energy (BLE).

DISABLED отключает чтение и запись конфигурации через Quick Sync.

Варианты:

  • "READ_WRITE"
  • "READ_ONLY"
  • "DISABLED"

timeout_limit

integer

Тайм-аут бездействия в секундах или минутах.

Допустимый диапазон: от 120 до 3600 секунд или от 2 до 60 минут.

Этот параметр обязателен, если enable_inactivity_timeout равно true.

timeout_limit_unit

string

Единица измерения тайм-аута бездействия.

SECONDS — задавать timeout_limit в секундах.

MINUTES — задавать timeout_limit в минутах.

Этот параметр обязателен, если enable_inactivity_timeout равно true.

Варианты:

  • "SECONDS"
  • "MINUTES"

timeout

integer

добавлено в dellemc.openmanage 5.0.0

Тайм-аут на уровне сокета в секундах.

По умолчанию: 30

username

string

Имя пользователя OpenManage Enterprise Modular.

Если имя пользователя не указано, используется переменная среды OME_USERNAME.

Пример: export OME_USERNAME=username

validate_certs

boolean

добавлено в dellemc.openmanage 5.0.0

Если false, SSL-сертификаты проверяться не будут.

Настраивайте false только на сайтах под личным контролем, где используются самоподписанные сертификаты.

В версиях коллекции до 5.0.0 параметр validate_certs по умолчанию имеет значение false.

Варианты:

  • false
  • true ← (по умолчанию)

x_auth_token

string

добавлено в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная среды OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к OpenManage Enterprise Modular.
  • Этот модуль поддерживает check_mode.
  • Модуль всегда будет сообщать об изменении, если enable_chassis_power_button равно true.

Примеры

---
- name: Configure KVM, direct access and power button settings of the chassis using device ID.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 25011
    enable_kvm_access: true
    enable_chassis_direct_access: false
    chassis_power_button:
      enable_chassis_power_button: false
      enable_lcd_override_pin: true
      disabled_button_lcd_override_pin: "123456"

- name: Configure Quick sync and LCD settings of the chassis using device service tag.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: GHRT2RL
    quick_sync:
      quick_sync_access: READ_ONLY
      enable_read_authentication: true
      enable_quick_sync_wifi: true
      enable_inactivity_timeout: true
      timeout_limit: 10
      timeout_limit_unit: MINUTES
    lcd:
      lcd_access: VIEW_ONLY
      lcd_language: en
      user_defined: "LCD Text"

- name: Configure all local access settings of the host chassis.
  dellemc.openmanage.ome_device_local_access_configuration:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    enable_kvm_access: true
    enable_chassis_direct_access: false
    chassis_power_button:
      enable_chassis_power_button: false
      enable_lcd_override_pin: true
      disabled_button_lcd_override_pin: "123456"
    quick_sync:
      quick_sync_access: READ_WRITE
      enable_read_authentication: true
      enable_quick_sync_wifi: true
      enable_inactivity_timeout: true
      timeout_limit: 120
      timeout_limit_unit: SECONDS
    lcd:
      lcd_access: VIEW_MODIFY
      lcd_language: en
      user_defined: "LCD Text"

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

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

Ключ

Описание

error_info

dictionary

Сведения об ошибке HTTP.

Возвращается: при ошибке HTTP

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to process the request because an error occurred.", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "Retry the operation. If the issue persists, contact your system administrator.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

location_details

dictionary

Возвращается при успешном обновлении параметров локального доступа.

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

Пример: {"EnableChassisDirect": false, "EnableChassisPowerButton": false, "EnableKvmAccess": true, "EnableLcdOverridePin": false, "LcdAccess": "VIEW_ONLY", "LcdCustomString": "LCD Text", "LcdLanguage": "en", "LcdOverridePin": "", "LcdPinLength": 6, "LcdPresence": "Present", "LedPresence": "Absent", "QuickSync": {"EnableInactivityTimeout": true, "EnableQuickSyncWifi": false, "EnableReadAuthentication": false, "QuickSyncAccess": "READ_ONLY", "QuickSyncHardware": "Present", "TimeoutLimit": 7, "TimeoutLimitUnit": "MINUTES"}, "SettingType": "LocalAccessConfiguration"}

msg

string

Общий статус параметров локального доступа устройства.

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

Пример: "Successfully updated the local access settings."

Авторы

  • Felix Stephen (@felixs88)
  • Shivam Sharma (@ShivamSh3)

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

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

© 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/openmanage/ome_device_local_access_configuration_module.html

Spec-Zone.ru

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