dellemc.openmanage.ome_network_vlan_info 模块 – 获取 OpenManage Enterprise 中存在的网络 VLAN 信息

注意

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

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

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

要在剧本中使用它，请指定： dellemc.openmanage.ome_network_vlan_info。

dellemc.openmanage 2.1.0 中的新增功能

概要

  • 此模块允许检索以下内容： - 包含其详细信息的所有网络 VLAN 的列表。 - 使用 VLAN _id_ 或 VLAN _name_ 获取特定网络 VLAN 的信息。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

dellemc.openmanage 5.0.0 中添加

包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。

hostname

字符串 / 必需

OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。

id

整数

设备中可用的网络 VLAN 的唯一标识符。

id 和 name 是互斥的。

name

字符串

设备中可用的网络 VLAN 的唯一名称。

name 和 id 是互斥的。

password

字符串

OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。

如果未提供密码，则使用环境变量 OME_PASSWORD。

示例：export OME_PASSWORD=password

port

整数

OpenManage Enterprise 或 OpenManage Enterprise Modular 的 HTTPS 端口。

默认值： 443

timeout

整数

dellemc.openmanage 5.0.0 中添加

以秒为单位的套接字级别超时。

默认值： 30

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: Retrieve information about all network VLANs(s) available in the device
  dellemc.openmanage.ome_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

- name: Retrieve information about a network VLAN using the VLAN ID
  dellemc.openmanage.ome_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    id: 12345

- name: Retrieve information about a network VLAN using the VLAN name
  dellemc.openmanage.ome_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Network VLAN - 1"

返回值

常见的返回值已记录在 此处，以下是此模块特有的字段

键

描述

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."}}

msg

字符串

网络 VLAN 的详细信息。

返回： 成功

示例： "{'msg': '已成功检索网络VLAN信息。', 'network_vlan_info': [{'CreatedBy': 'admin', 'CreationTime': '2020-09-02 18:48:42.129', 'Description': '逻辑网络描述 - 1', 'Id': 20057, 'InternalRefNWUUId': '42b9903d-93f8-4184-adcf-0772e4492f71', 'Name': '网络VLAN - 1', 'Type': {'Description': '这是用于一般用途流量的网络。QOS优先级：青铜。', 'Id': 1, 'Name': '通用用途（青铜）', 'NetworkTrafficType': '以太网', 'QosType': {'Id': 4, 'Name': '青铜'}, 'VendorCode': 'GeneralPurpose'}, 'UpdatedBy': None, 'UpdatedTime': '2020-09-02 18:48:42.129', 'VlanMaximum': 111, 'VlanMinimum': 111}, {'CreatedBy': 'admin', 'CreationTime': '2020-09-02 18:49:11.507', 'Description': '逻辑网络描述 - 2', 'Id': 20058, 'InternalRefNWUUId': 'e46ccb3f-ef57-4617-ac76-46c56594005c', 'Name': '网络VLAN - 2', 'Type': {'Description': '这是用于一般用途流量的网络。QOS优先级：白银。', 'Id': 2, 'Name': '通用用途（白银）', 'NetworkTrafficType': '以太网', 'QosType': {'Id': 3, 'Name': '白银'}, 'VendorCode': 'GeneralPurpose'}, 'UpdatedBy': None, 'UpdatedTime': '2020-09-02 18:49:11.507', 'VlanMaximum': 112, 'VlanMinimum': 112}]}"

作者

  • Deepak Joshi(@deepakjoshishri)