dellemc.openmanage.ome_smart_fabric_uplink_info 模块 – 获取 OpenManage Enterprise Modular 上结构上行链路的详细信息。

注意

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

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块，请参阅要求获取详细信息。

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

dellemc.openmanage 7.1.0 中的新增功能

概要 

此模块检索 OpenManage Enterprise Modular 上结构上行链路的详细信息。

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的 Privacy Enhanced Mail (PEM) 文件。
fabric_id 字符串	结构的唯一 ID。 fabric_id 与 fabric_name 互斥。
fabric_name 字符串	结构的唯一名称。 fabric_name 与 fabric_id 互斥。
hostname 字符串 / 必填	OpenManage Enterprise Modular IP 地址或主机名。
password 字符串	OpenManage Enterprise Modular 密码。如果未提供密码，则使用环境变量 `OME_PASSWORD`。示例：export OME_PASSWORD=password
port 整数	OpenManage Enterprise Modular HTTPS 端口。默认： `443`
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别超时（以秒为单位）。默认： `30`
uplink_id 字符串	上行链路的唯一 ID。 uplink_id 与 uplink_name 互斥。 fabric_id 或 fabric_name 需要与 uplink_id 一起使用。
uplink_name 字符串	上行链路的唯一名称。 uplink_name 与 uplink_id 互斥。 fabric_id 或 fabric_name 需要与 uplink_name 一起使用。
username 字符串	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 Modular 的系统运行此模块。
此模块支持 check_mode。

示例 

---
- name: Retrieve all fabric uplink information using fabric_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"

- name: Retrieve all fabric uplink information using fabric_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_name: "f1"

- name: Retrieve specific fabric information using uplink_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_id: "1ad54420-b145-49a1-9779-21a579ef6f2d"

- name: Retrieve specific fabric information using uplink_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_name: "u1"

返回值 

通用返回值记录在此处，以下是此模块特有的字段

键	描述
error_info 字典	HTTP 错误的详细信息。已返回：发生 HTTP 错误时示例： `{"error": {"@Message.ExtendedInfo": [{"Message": "由于资源 URI 不存在或未实现，无法完成请求。", "MessageArgs": [], "MessageId": "CGEN1006", "RelatedProperties": [], "Resolution": "检查请求资源 URI。有关资源 URI 及其属性的详细信息，请参阅 OpenManage Enterprise-Modular 用户指南。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生了一般错误。有关详细信息，请参阅 ExtendedInfo。"}}`
msg 字符串	结构上行链路信息检索的状态。返回：总是示例： `"成功检索到结构上行链路信息。"`
uplink_info 列表 / 元素=字符串	关于结构上行链路的信息。返回：成功时示例： [{"Description": "", "Id": "1ad54420-b145-49a1-9779-21a579ef6f2d", "MediaType": "Ethernet", "Name": "u1", "NativeVLAN": 1, "Networks": [{"CreatedBy": "system", "CreationTime": "2018-09-25 14:46:12.374", "Description": null, "Id": 10155, "InternalRefNWUUId": "f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d", "Name": "testvlan", "Type": 1, "UpdatedBy": "root", "UpdatedTime": "2019-06-27 15:06:22.836", "VlanMaximum": 143, "VlanMinimum": 143}], "Ports": [{"AdminStatus": "Enabled", "BlinkStatus": "OFF", "ConfiguredSpeed": "0", "CurrentSpeed": "0", "Description": "", "Id": "SVCTAG1:ethernet1/1/35", "MaxSpeed": "0", "MediaType": "Ethernet", "Name": "", "NodeServiceTag": "SVCTAG1", "OpticsType": "NotPresent", "PortNumber": "ethernet1/1/35", "Role": "Uplink", "Status": "Down", "Type": "PhysicalEthernet"}, {"AdminStatus": "Enabled", "BlinkStatus": "OFF", "ConfiguredSpeed": "0", "CurrentSpeed": "0", "Description": "", "Id": "SVCTAG1:ethernet1/1/35", "MaxSpeed": "0", "MediaType": "Ethernet", "Name": "", "NodeServiceTag": "SVCTAG1", "OpticsType": "NotPresent", "PortNumber": "ethernet1/1/35", "Role": "Uplink", "Status": "Down", "Type": "PhysicalEthernet"}], "Summary": {"NetworkCount": 1, "PortCount": 2}, "UfdEnable": "Disabled"}]

作者

Husniya Hameed(@husniya_hameed)