модуль dellemc.openmanage.ome_template_network_vlan — Назначение VLAN с тегами и без тегов встроенной сетевой карте, поддерживаемой шаблоном в OpenManage Enterprise

Примечание

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

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

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

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

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

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

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

Этот модуль позволяет назначать VLAN с тегами и без тегов встроенной сетевой карте, поддерживаемой шаблоном в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA для проверки.
hostname строка / обязательный	IP-адрес или имя хоста OpenManage Enterprise либо OpenManage Enterprise Modular.
nic_identifier строка / обязательный	Отображаемое имя порта NIC в шаблоне для настройки VLAN.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	HTTPS-порт OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
propagate_vlan логический добавлено в dellemc.openmanage 3.4.0	Немедленно развернуть измененные параметры VLAN без перезагрузки сервера. Этот параметр применяется только при наличии изменений в конфигурации VLAN. Варианты: `false` `true` ← (по умолчанию)
tagged_networks список / элементы=словарь	Список VLAN с тегами и соответствующих им портов NIC.
port целое число / обязательный	Номер порта NIC для VLAN с тегом
tagged_network_ids список / элементы=целое число	Список идентификаторов VLAN с тегами Укажите [], чтобы удалить VLAN с тегом из порта. При добавлении VLAN с тегами в порт список tagged_network_ids объединяется со списком tagged_network_names. Чтобы получить идентификатор сети VLAN, используйте API ` https://I(hostname <%20https://I(hostname>`__/api/NetworkConfigurationService/Networks)
tagged_network_names список / элементы=строка	Список имен VLAN с тегами Укажите [], чтобы удалить VLAN с тегом из порта. При добавлении VLAN с тегами в порт список tagged_network_names объединяется со списком tagged_network_ids.
template_id целое число	Идентификатор шаблона. Этот параметр нельзя использовать вместе с template_name.
template_name строка	Имя шаблона. Этот параметр нельзя использовать вместе с template_id.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
untagged_networks список / элементы=словарь	Список сетей без тегов и соответствующих им портов NIC.
port целое число / обязательный	Номер порта NIC для VLAN без тега.
untagged_network_id целое число	Идентификатор VLAN без тега Укажите 0, чтобы очистить VLAN без тега на порту. Этот параметр нельзя использовать вместе с untagged_network_name. Чтобы получить идентификатор сети VLAN, используйте API ` https://I(hostname <%20https://I(hostname>`__/api/NetworkConfigurationService/Networks)
untagged_network_name строка	Имя VLAN для настройки без тега Укажите 0, чтобы очистить настройку VLAN без тега для этого port. Этот параметр нельзя использовать вместе с untagged_network_id.
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs логический добавлено в dellemc.openmanage 5.0.0	Если `false`, SSL-сертификаты не проверяются. Настраивайте `false` только на площадках, находящихся под вашим контролем, где используются самоподписанные сертификаты. В версиях коллекции до `5.0.0` параметр validate_certs по умолчанию имеет значение `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в 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.

Примеры

---
- name: Add tagged or untagged VLANs to a template using VLAN ID and name
  dellemc.openmanage.ome_template_network_vlan:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_id: 78
    nic_identifier: NIC Slot 4
    untagged_networks:
      - port: 1
        untagged_network_id: 127656
      - port: 2
        untagged_network_name: vlan2
    tagged_networks:
      - port: 1
        tagged_network_ids:
          - 12767
          - 12768
      - port: 4
        tagged_network_ids:
          - 12767
          - 12768
        tagged_network_names:
          - vlan3
      - port: 2
        tagged_network_names:
          - vlan4
          - vlan1

- name: Clear the tagged and untagged VLANs from a template
  dellemc.openmanage.ome_template_network_vlan:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_id: 78
    nic_identifier: NIC Slot 4
    untagged_networks:
      # For removing the untagged VLANs for the port 1 and 2
      - port: 1
        untagged_network_id: 0
      - port: 2
        untagged_network_name: 0
    tagged_networks:
      # For removing the tagged VLANs for port 1, 4 and 2
      - port: 1
        tagged_network_ids: []
      - port: 4
        tagged_network_ids: []
        tagged_network_names: []
      - port: 2
        tagged_network_names: []

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

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

Ключ	Описание
error_info словарь	Подробная информация об ошибке HTTP. Возвращается: при ошибке HTTP Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because TemplateId does not exist or is not applicable for the resource URI.", "MessageArgs": ["TemplateId"], "MessageId": "CGEN1004", "RelatedProperties": [], "Resolution": "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}
msg строка	Общий статус операции с VLAN шаблона. Возвращается: всегда Пример: `"Successfully applied the network settings to template."`

Ключ

Описание

error_info

словарь

Подробная информация об ошибке HTTP.

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

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because TemplateId does not exist or is not applicable for the resource URI.", "MessageArgs": ["TemplateId"], "MessageId": "CGEN1004", "RelatedProperties": [], "Resolution": "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

строка

Общий статус операции с VLAN шаблона.

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

Пример: "Successfully applied the network settings to template."

Авторы

Jagadeesh N V(@jagadeeshnv)

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

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