Модуль dellemc.openmanage.ome_template_network_vlan – Установка помеченных и непомеченных VLAN на сетевую карту по умолчанию, поддерживаемую шаблоном в OpenManage Enterprise

Примечание

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

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

END_OF_DOCUMENT_MARKER

validate_certs

boolean

added in dellemc.openmanage 5.0.0

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

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

До версии коллекции 5.0.0, validate_certs устанавливался по умолчанию в false.

Варианты:

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

x_auth_token

string

added in 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_template_network_vlan_module.html