dellemc.openmanage.ome_template_network_vlan 模块 – 在 OpenManage Enterprise 上为模板支持的本机网卡设置标记的和未标记的 VLAN

注意

此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：dellemc.openmanage.ome_template_network_vlan。

dellemc.openmanage 2.0.0 中的新功能

概要

• 此模块允许为 OpenManage Enterprise 上模板支持的本机网卡设置标记的和未标记的 VLAN。

要求

执行此模块的主机需要以下要求。

• python >= 3.9.6

参数

参数	注释
ca_path 路径 在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
hostname 字符串 / 必填	OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。
nic_identifier 字符串 / 必填	VLAN 配置的模板中 NIC 端口的显示名称。
password 字符串	OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码，则使用环境变量 OME_PASSWORD。 示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。 默认： 443
propagate_vlan 布尔值 在 dellemc.openmanage 3.4.0 中添加	立即部署修改后的 VLAN 设置，而无需重新启动服务器。 仅当 VLAN 配置发生更改时，此选项才适用。 选项 false true ← (默认)
tagged_networks 列表 / elements=字典	标记的 VLAN 及其对应的 NIC 端口的列表。
port 整数 / 必填	标记的 VLAN 的 NIC 端口号
tagged_network_ids 列表 / elements=整数	标记的 VLAN 的 ID 列表 输入 [] 从端口中删除标记的 VLAN。 在向端口添加标记的 VLAN 时，tagged_network_ids 列表与 tagged_network_names 列表组合使用。 要获取 VLAN 网络 ID，请使用 API ` https://I(hostname <%20https://I(hostname>`__/api/NetworkConfigurationService/Networks)
tagged_network_names 列表 / elements=字符串	标记的 VLAN 的名称列表 输入 [] 从端口中删除标记的 VLAN。 在向端口添加标记的 VLAN 时，tagged_network_names 列表与 tagged_network_ids 列表组合使用。
template_id 整数	模板的 ID。 它与 template_name 互斥。
template_name 字符串	模板的名称。 它与 template_id 互斥。
timeout 整数 在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时（以秒为单位）。 默认： 30
untagged_networks 列表 / elements=字典	未标记的网络及其对应的 NIC 端口的列表。
port 整数 / 必填	未标记的 VLAN 的 NIC 端口号。
untagged_network_id 整数	未标记的 VLAN 的 ID 输入 0 可从端口清除未标记的 VLAN。 此选项与 untagged_network_name 互斥 要获取 VLAN 网络 ID，请使用 API ` https://I(hostname <%20https://I(hostname>`__/api/NetworkConfigurationService/Networks)
untagged_network_name 字符串	用于取消标记的 VLAN 的名称 为此 port 清除取消标记，请提供 0 此参数与 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": "由于 TemplateId  不存在或不适用于资源 URI， 无法完成请求。", "MessageArgs": ["TemplateId"], "MessageId": "CGEN1004", "RelatedProperties": [], "Resolution": "检查请求资源 URI。 有关资源 URI 及其属性的更多信息，请参阅 OpenManage Enterprise-Modular 用户指南。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。 有关更多信息，请参阅 ExtendedInfo。"}}
msg 字符串	模板 VLAN 操作的总体状态。 返回： 始终 示例： "已成功将网络设置应用于模板。"

作者

• Jagadeesh N V(@jagadeeshnv)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）