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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 словарь	Атрибуты для `modify` и `assign`.
Attributes список / элементы=словарь	Список атрибутов, которые необходимо изменить, когда команда равна `modify`. Список атрибутов, которые необходимо переопределить, когда команда равна `assign`. Используйте Id, если идентификатор атрибута доступен. В противном случае используйте разделенный запятыми I (DisplayName). Подробнее об использовании DisplayName см. в предоставленном примере.
Options словарь	Предоставляет различные параметры завершения работы. Это применимо, когда команда равна `assign`.
Schedule словарь	Расписание для развертывания профиля. Это применимо, когда команда равна `assign`.
boot_to_network_iso словарь	Подробная информация о доступе к ISO. Применимо, когда команда равна `create`, `assign`, и `modify`.
boot_to_network булево / обязательный	Включить или отключить сетевую общую папку. Варианты: `false` `true`
iso_path строка	Укажите полный путь к ISO, включая имя общего ресурса.
iso_timeout целое число	Установите количество часов, в течение которого файл сетевого ISO будет отображаться на целевом устройстве(ах). Варианты: `1` `2` `4` ← (по умолчанию) `8` `16`
share_ip строка	IP-адрес сетевой общей папки.
share_password строка	Пароль пользователя, когда share_type равен `CIFS`.
share_type строка	Тип сетевой общей папки. Варианты: `"NFS"` `"CIFS"`
share_user строка	Имя пользователя, когда share_type равен `CIFS`.
workgroup строка	Рабочая группа пользователя, когда share_type равен `CIFS`.
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, используемый для проверки.
command строка	`create` создает новые профили. `modify` изменяет существующий профиль. Можно изменить только name, description, boot_to_network_iso и attributes. `delete` удаляет существующий профиль. `assign` развертывает существующий профиль на целевом устройстве и возвращает идентификатор задачи. `unassign` отменяет назначение профиля с указанного целевого устройства и возвращает идентификатор задачи. `migrate` мигрирует существующий профиль и возвращает идентификатор задачи. Варианты: `"create"` ← (по умолчанию) `"modify"` `"delete"` `"assign"` `"unassign"` `"migrate"`
description строка	Описание профиля.
device_id целое число	Идентификатор целевого устройства. Это применимо, когда команда равна `assign` и `migrate`. Этот параметр взаимоисключающий с device_service_tag.
device_service_tag строка	Идентификатор целевого устройства. Как правило, длина составляет от 7 до 8 символов. Применимо, когда команда равна `assign`, и `migrate`. Этот параметр взаимоисключающий с device_id. Если устройство не существует, когда команда равна `assign`, профиль автоматически развертывается.
filters словарь	Фильтрует профили на основе выбранных критериев. Это применимо, когда команда равна `delete` или `unassign`. Поддерживает подпараметр ProfileIds, который принимает список идентификаторов профилей. Также поддерживает выражения фильтрации OData с подпараметром Filters. См. руководство по API REST OpenManage Enterprise для доступных вариантов фильтрации. ВНИМАНИЕ При использовании этого параметра в случае `unassign`, идентификатор задачи не возвращается ни для одного из затронутых профилей.

END_OF_DOCUMENT_MARKER

force boolean	Предоставляет возможность принудительной миграции профиля, даже если исходное устройство недоступно. Эта опция применима, когда command равен `migrate`. Варианты: `false` ← (по умолчанию) `true`
hostname string / required	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 словарь	Подробная информация об ошибке 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 целое число	Идентификатор задачи, созданной, когда команда равна `assign`, `migrate` или `unassign`. Операции `assign` и `unassign` не запускают задачу, если профиль автоматически развернут. Возвращается: когда команда равна `assign`, `migrate` или `unassign` Пример: `14123`
msg строка	Общий статус операции с профилем. Возвращается: всегда Пример: `"Successfully created 2 profile(s)."`
profile_ids список / элементы=строка	Идентификаторы созданных профилей. Возвращается: когда команда равна `create` Пример: `[1234, 5678]`

Авторы

Jagadeesh N V (@jagadeeshnv)

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

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