Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_profile — создание, изменение, удаление, назначение, снятие назначения и миграция профиля в OpenManage Enterprise

Примечание

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

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

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

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

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

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

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

  • Этот модуль позволяет создавать, изменять, удалять, назначать, снимать назначение и переносить профиль в OpenManage Enterprise.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

attributes

dictionary

Атрибуты для modify и assign.

Attributes

list / elements=dictionary

Список атрибутов для изменения, если значение command — modify.

Список атрибутов для переопределения, если значение command — assign.

Используйте Id, если доступен идентификатор атрибута. В противном случае используйте разделенный запятыми список I (DisplayName). Подробнее об использовании DisplayName см. в приведенном примере.

Options

dictionary

Предоставляет различные варианты завершения работы.

Применимо, если значение command — assign.

Schedule

dictionary

Расписание развертывания профиля.

Применимо, если значение command — assign.

boot_to_network_iso

dictionary

Сведения об ISO-образе на общем ресурсе.

Применимо, если значение command — create, assign и modify.

boot_to_network

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

Включить или отключить сетевой общий ресурс.

Варианты:

  • false
  • true

iso_path

string

Укажите полный путь к ISO-образу, включая имя общего ресурса.

iso_timeout

integer

Задайте количество часов, в течение которых сетевой ISO-файл будет подключен к целевому устройству или устройствам.

Варианты:

  • 1
  • 2
  • 4 ← (по умолчанию)
  • 8
  • 16

share_ip

string

IP-адрес сетевого общего ресурса.

share_password

string

Пароль пользователя, если значение share_type — CIFS.

share_type

string

Тип сетевого общего ресурса.

Варианты:

  • "NFS"
  • "CIFS"

share_user

string

Имя пользователя, если значение share_type — CIFS.

workgroup

string

Рабочая группа пользователя, если значение share_type — CIFS.

ca_path

path

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

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

command

string

create создает новые профили.

modify изменяет существующий профиль. Можно изменить только name, description, boot_to_network_iso и attributes.

delete удаляет существующий профиль.

assign Развертывает существующий профиль на целевом устройстве и возвращает идентификатор задачи.

unassign снимает назначение профиля с указанного целевого устройства и возвращает идентификатор задачи.

migrate переносит существующий профиль и возвращает идентификатор задачи.

Варианты:

  • "create" ← (по умолчанию)
  • "modify"
  • "delete"
  • "assign"
  • "unassign"
  • "migrate"

description

string

Описание профиля.

device_id

integer

Идентификатор целевого устройства.

Применимо, если значение command — assign и migrate.

Этот параметр нельзя использовать одновременно с device_service_tag.

device_service_tag

string

Идентификатор целевого устройства.

Обычно его длина составляет от 7 до 8 символов.

Применимо, если значение command — assign и migrate.

Этот параметр нельзя использовать одновременно с device_id.

Если устройство не существует, когда значение command — assign, профиль развертывается автоматически.

filters

dictionary

Фильтрует профили по выбранным критериям.

Применимо, если значение command — delete или unassign.

Поддерживается дополнительный параметр ProfileIds, которому передается список идентификаторов профилей.

Также поддерживаются выражения фильтров OData с дополнительным параметром Filters.

Доступные параметры фильтрации см. в руководстве по REST API OpenManage Enterprise.

ПРЕДУПРЕЖДЕНИЕ При использовании этого параметра с unassign идентификатор задачи не возвращается ни для одного затронутого профиля.

force

boolean

Позволяет принудительно перенести профиль, даже если не удается связаться с исходным устройством.

Этот параметр применим, если значение command — migrate.

Варианты:

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

hostname

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

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

name

string

Имя профиля.

Применимо для операций изменения, удаления, назначения, снятия назначения и переноса.

Этот параметр нельзя использовать одновременно с name_prefix и number_of_profiles.

name_prefix

string

Указанное при создании профиля имя используется в качестве префикса, за которым следует номер, присвоенный профилю в OpenManage Enterprise.

Применимо только для операции создания.

Этот параметр нельзя использовать одновременно с name.

По умолчанию: "Profile"

new_name

string

Новое имя профиля.

Применимо, если значение command — modify.

number_of_profiles

integer

Укажите количество создаваемых профилей.

Применимо, если параметр name_prefix используется с create.

Этот параметр нельзя использовать одновременно с name.

OpenManage Enterprise может создать не более 100 профилей.

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

password

string

Пароль OpenManage Enterprise или OpenManage Enterprise Modular.

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

Пример: export OME_PASSWORD=password

port

integer

HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular.

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

template_id

integer

Идентификатор шаблона.

Применимо, если значение command — create.

Этот параметр нельзя использовать одновременно с template_name.

template_name

string

Имя шаблона для создания профиля или профилей.

Применимо, если значение command — create.

Этот параметр нельзя использовать одновременно с template_id.

timeout

integer

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

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

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

username

string

Имя пользователя OpenManage Enterprise или 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

Примечания

Примечание

  • Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise.
  • Этот модуль поддерживает check_mode.
  • assign повторное назначение уже назначенного профиля не приведет к повторному развертыванию.

Примеры

---
- name: Create two profiles from a template
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_name: "template 1"
    name_prefix: "omam_profile"
    number_of_profiles: 2

- name: Create profile with NFS share
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: create
    template_name: "template 1"
    name_prefix: "omam_profile"
    number_of_profiles: 1
    boot_to_network_iso:
      boot_to_network: true
      share_type: NFS
      share_ip: "192.168.0.1"
      iso_path: "path/to/my_iso.iso"
      iso_timeout: 8

- name: Create profile with CIFS share
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: create
    template_name: "template 1"
    name_prefix: "omam_profile"
    number_of_profiles: 1
    boot_to_network_iso:
      boot_to_network: true
      share_type: CIFS
      share_ip: "192.168.0.2"
      share_user: "username"
      share_password: "password"
      workgroup: "workgroup"
      iso_path: "\\path\\to\\my_iso.iso"
      iso_timeout: 8

- name: Modify profile name with NFS share and attributes
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: modify
    name: "Profile 00001"
    new_name: "modified profile"
    description: "new description"
    boot_to_network_iso:
      boot_to_network: true
      share_type: NFS
      share_ip: "192.168.0.3"
      iso_path: "path/to/my_iso.iso"
      iso_timeout: 8
    attributes:
      Attributes:
        - Id: 4506
          Value: "server attr 1"
          IsIgnored: false
        - Id: 4507
          Value: "server attr 2"
          IsIgnored: false
        # Enter the comma separated string as appearing in the Detailed view on GUI
        # System -> Server Topology -> ServerTopology 1 Aisle Name
        - DisplayName: 'System, Server Topology, ServerTopology 1 Aisle Name'
          Value: Aisle 5
          IsIgnored: false

- name: Delete a profile using profile name
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "delete"
    name: "Profile 00001"

- name: Delete profiles using filters
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "delete"
    filters:
      SelectAll: true
      Filters: =contains(ProfileName,'Profile 00002')

- name: Delete profiles using profile list filter
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "delete"
    filters:
      ProfileIds:
        - 17123
        - 16124

- name: Assign a profile to target along with network share
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: assign
    name: "Profile 00001"
    device_id: 12456
    boot_to_network_iso:
      boot_to_network: true
      share_type: NFS
      share_ip: "192.168.0.1"
      iso_path: "path/to/my_iso.iso"
      iso_timeout: 8
    attributes:
      Attributes:
        - Id: 4506
          Value: "server attr 1"
          IsIgnored: true
      Options:
        ShutdownType: 0
        TimeToWaitBeforeShutdown: 300
        EndHostPowerState: 1
        StrictCheckingVlan: true
      Schedule:
        RunNow: true
        RunLater: false

- name: Unassign a profile using profile name
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "unassign"
    name: "Profile 00003"

- name: Unassign profiles using filters
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "unassign"
    filters:
      SelectAll: true
      Filters: =contains(ProfileName,'Profile 00003')

- name: Unassign profiles using profile list filter
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "unassign"
    filters:
      ProfileIds:
        - 17123
        - 16123

- name: Migrate a profile
  dellemc.openmanage.ome_profile:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "migrate"
    name: "Profile 00001"
    device_id: 12456

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

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

Ключ

Описание

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."}}

job_id

integer

Идентификатор задачи, созданной, когда значение command — assign, migrate или unassign.

Операции assign и unassign не запускают задачу, если профиль развертывается автоматически.

Возвращается: когда значение command — assign, migrate или unassign

Пример: 14123

msg

string

Общий статус операции с профилем.

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

Пример: "Successfully created 2 profile(s)."

profile_ids

list / elements=string

Идентификаторы созданных профилей.

Возвращается: когда значение command — create

Пример: [1234, 5678]

Авторы

  • Jagadeesh N V (@jagadeeshnv)
  • Bhavneet Sharma (@Bhavneet-Sharma)

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

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

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

Spec-Zone.ru

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