Модуль dellemc.openmanage.ome_network_vlan – Создание, изменение и удаление VLAN

Примечание

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

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

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

Для использования в playbook, укажите: dellemc.openmanage.ome_network_vlan.

Новое в dellemc.openmanage 2.1.0

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

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

Этот модуль позволяет,
Создавать VLAN в OpenManage Enterprise.
Изменять или удалять существующие VLAN в OpenManage Enterprise.

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
description строка	Краткое описание VLAN, который будет создан или изменен.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
name строка / обязательно	Укажите имя VLAN, который нужно создать, удалить или изменить.
new_name строка	Укажите имя VLAN, который нужно изменить.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
state строка	`present` создает новый VLAN или изменяет существующий VLAN. `absent` удаляет существующий VLAN. ПРЕДУПРЕЖДЕНИЕ Удаление VLAN может повлиять на сетевую инфраструктуру. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
type строка	Типы поддерживаемых VLAN сетей. Для описания каждого типа сети используйте API https://I(hostname/api/NetworkConfigurationService/NetworkTypes). Варианты: `"General Purpose (Bronze)"` `"General Purpose (Silver)"` `"General Purpose (Gold)"` `"General Purpose (Platinum)"` `"Cluster Interconnect"` `"Hypervisor Management"` `"Storage - iSCSI"` `"Storage - FCoE"` `"Storage - Data Replication"` `"VM Migration"` `"VMWare FT Logging"`
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` ← (по умолчанию)
vlan_maximum целое число	Максимальное значение VLAN в диапазоне. Создается VLAN с одним значением, если значения vlan_maximum и vlan_minmum совпадают.
vlan_minimum целое число	Минимальное значение VLAN в диапазоне.
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: Create a VLAN range
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    name: "vlan1"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 35
    vlan_maximum: 40
  tags: create_vlan_range

- name: Create a VLAN with a single value
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    name: "vlan2"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 127
    vlan_maximum: 127
  tags: create_vlan_single

- name: Modify a VLAN
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    ca_path: "/path/to/ca_cert.pem"
    state: present
    name: "vlan1"
    new_name: "vlan_gold1"
    description: "new description"
    type: "General Purpose (Gold)"
    vlan_minimum: 45
    vlan_maximum: 50
  tags: modify_vlan

- name: Delete a VLAN
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    name: "vlan1"
  tags: delete_vlan

Значения возврата

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

Ключ	Описание
error_info словарь	Подробности об HTTP-ошибке. Возвращается: при ошибке HTTP Пример: {"@Message.ExtendedInfo": [{"Message": "Unable to create or update the network because the entered VLAN minimum 0 is not within a valid range ( 1 - 4000 or 4021 - 4094 ).", "MessageArgs": ["0", "1", "4000", "4021", "4094"], "MessageId": "CTEM1043", "RelatedProperties": [], "Resolution": "Enter a valid VLAN minimum as identified in the message and retry the operation.", "Severity": "Warning"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}
msg строка	Общий статус операции с VLAN. Возвращается: всегда Пример: `"Successfully created the VLAN."`
vlan_status словарь	Подробности VLAN, который был создан или изменён. Возвращается: когда state=present Пример: `{"@odata.context": "/api/$metadata#NetworkConfigurationService.Network", "@odata.id": "/api/NetworkConfigurationService/Networks(1234)", "@odata.type": "#NetworkConfigurationService.Network", "CreatedBy": "admin", "CreationTime": "2020-01-01 05:54:36.113", "Description": "VLAN description", "Id": 1234, "InternalRefNWUUId": "6d6effcc-eca4-44bd-be07-1234ab5cd67e", "Name": "vlan1", "Type": 1, "UpdatedBy": null, "UpdatedTime": "2020-01-01 05:54:36.113", "VlanMaximum": 130, "VlanMinimum": 140}`

Авторы

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_network_vlan_module.html