dellemc.openmanage.ome_network_port_breakout 模块 – 此模块允许自动化端口划分或端口拆分到逻辑子端口

注意

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

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

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

要在 playbook 中使用它,请指定:dellemc.openmanage.ome_network_port_breakout

dellemc.openmanage 2.1.0 中的新增功能

概要

  • 此模块允许自动化将 Fabric 模式下的 IOM 分解为逻辑子端口。

  • 端口拆分操作仅在 OpenManage Enterprise Modular 中受支持。

要求

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

  • python >= 3.9.6

参数

参数

注释

breakout_type

字符串 / 必需

首选的拆分类型。例如,4X10GE。

要撤销默认拆分配置,请输入“HardwareDefault”。

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

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

hostname

字符串 / 必需

OpenManage Enterprise Modular IP 地址或主机名。

password

字符串

OpenManage Enterprise Modular 密码。

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

示例:export OME_PASSWORD=password

port

整数

OpenManage Enterprise Modular HTTPS 端口。

默认值: 443

target_port

字符串 / 必需

交换机中要拆分的端口的 ID。以以下格式输入端口 ID:服务 标签:端口。例如,2HB7NX2:ethernet1/1/13。

timeout

整数

在 dellemc.openmanage 5.0.0 中添加

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

默认值: 30

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: Port breakout configuration
  dellemc.openmanage.ome_network_port_breakout:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    target_port: "2HB7NX2:phy-port1/1/11"
    breakout_type: "1X40GE"

- name: Revoke the default breakout configuration
  dellemc.openmanage.ome_network_port_breakout:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    target_port: "2HB7NX2:phy-port1/1/11"
    breakout_type: "HardwareDefault"

返回值

通用返回值记录在此处:此处,以下是此模块独有的字段

描述

breakout_status

字典

OpenManage Enterprise 作业的详细信息。

返回值:成功

示例: {"Builtin": false, "CreatedBy": "root", "Editable": true, "EndTime": null, "Id": 11111, "JobDescription": "", "JobName": "Breakout Port", "JobStatus": {"Id": 1112, "Name": "New"}, "JobType": {"Id": 3, "Internal": false, "Name": "DeviceAction_Task"}, "LastRun": null, "LastRunStatus": {"Id": 1113, "Name": "NotRun"}, "NextRun": null, "Params": [{"JobId": 11111, "Key": "operationName", "Value": "CONFIGURE_PORT_BREAK_OUT"}, {"JobId": 11111, "Key": "interfaceId", "Value": "2HB7NX2:phy-port1/1/11"}, {"JobId": 11111, "Key": "breakoutType", "Value": "1X40GE"}], "Schedule": "startnow", "StartTime": null, "State": "Enabled", "Targets": [{"Data": "", "Id": 11112, "JobId": 34206, "TargetType": {"Id": 1000, "Name": "DEVICE"}}], "UpdatedBy": null, "UserGenerated": true, "Visible": true}

error_info

字典

HTTP 错误的详细信息。

返回: 在 HTTP 错误时返回

示例: {"error": {"@Message.ExtendedInfo": [{"Message": "由于发生错误,无法处理请求。", "MessageArgs": [], "MessageId": "GEN1234", "RelatedProperties": [], "Resolution": "重试操作。如果问题仍然存在,请联系您的系统管理员。", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关详细信息,请参阅 ExtendedInfo。"}}

msg

字符串

端口配置的总体状态。

返回: 总是返回

示例: "端口分拆配置作业已成功提交。"

作者

  • Felix Stephen (@felixs88)