Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

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

Описание

  • Этот модуль позволяет настроить локальные параметры доступа к кнопке питания, быстрому синхронизации, KVM, LCD и прямому доступу к шасси в OpenManage Enterprise Modular.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

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

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

chassis_power_button

словарь

Настройки кнопки питания шасси.

disabled_button_lcd_override_pin

строка

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

Требуется, когда enable_lcd_override_pin true.

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

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

enable_chassis_power_button

булево / обязательно

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

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

Варианты:

  • false
  • true

enable_lcd_override_pin

булево

Включает или отключает PIN переопределения LCD.

Требуется, когда enable_chassis_power_button false.

Варианты:

  • false
  • true

device_id

целое число

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

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

device_id взаимно исключает device_service_tag.

device_service_tag

строка

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

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

device_service_tag взаимно исключает device_id.

enable_chassis_direct_access

булево

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

Варианты:

  • false
  • true

enable_kvm_access

булево

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

Варианты:

  • false
  • true

hostname

строка / обязательно

IP-адрес или имя хоста OpenManage Enterprise Modular.

lcd

словарь

Настройки LCD.

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

lcd_access

строка

Параметр для настройки быстрой синхронизации с помощью LCD.

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

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

DISABLED для отключения доступа.

Варианты:

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

lcd_language

строка

Код языка, в котором текст на LCD должен отображаться.

en для установки английского языка.

fr для установки французского языка.

de для установки немецкого языка.

es для установки испанского языка.

ja для установки японского языка.

zh для установки китайского языка.

user_defined

строка

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

password

строка

Пароль OpenManage Enterprise Modular.

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

Пример: export OME_PASSWORD=password

port

целое число

Порт HTTPS OpenManage Enterprise Modular.

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

quick_sync

словарь

Настройки для быстрой синхронизации.

Параметры quick_sync игнорируются, если оборудование быстрой синхронизации отсутствует.

enable_inactivity_timeout

булево

Включает или отключает таймаут неактивности.

Варианты:

  • 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 позволяет записывать конфигурацию с помощью быстрого синхронизации.

READ_ONLY разрешает только чтение Wi-Fi и Bluetooth Low Energy(BLE).

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

Варианты:

  • "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=имя_пользователя

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

словарь

Подробности 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

словарь

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

Возвращается: при успехе

Пример: {"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

строка

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

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

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

Авторы

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

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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