dellemc.openmanage.ome_device_network_services 模块 – 在 OpenManage Enterprise Modular 上配置机箱网络服务设置

注意

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

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

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

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

dellemc.openmanage 4.3.0 中的新增功能

概要

  • 此模块允许在 OpenManage Enterprise Modular 上配置网络服务。

要求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

在 dellemc.openmanage 5.0.0 中添加

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

device_id

整数

需要更新设置的机箱的 ID。

如果未指定设备 ID，则此模块会更新 hostname 的网络服务设置。

device_id 与 device_service_tag 互斥。

device_service_tag

字符串

需要更新设置的机箱的服务标签。

如果未指定设备服务标签，则此模块会更新 hostname 的网络服务设置。

device_service_tag 与 device_id 互斥。

hostname

字符串 / 必需

OpenManage Enterprise Modular IP 地址或主机名。

password

字符串

OpenManage Enterprise Modular 密码。

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

示例：export OME_PASSWORD=password

port

整数

OpenManage Enterprise Modular HTTPS 端口。

默认值： 443

remote_racadm_settings

字典

远程 RACADM 配置的设置。

enabled

布尔值 / 必需

启用或禁用远程 RACADM 设置。

选项

  • false

  • true

snmp_settings

字典

SNMP 配置的设置。

community_name

字符串

SNMP 团体字符串。

当 enabled 为 true 时为必需项。

enabled

布尔值 / 必需

启用或禁用 SNMP 设置。

选项

  • false

  • true

port_number

整数

SNMP 端口号。

ssh_settings

字典

SSH 配置的设置。

enabled

布尔值 / 必需

启用或禁用 SSH 设置。

选项

  • false

  • true

idle_timeout

浮点数

SSH 空闲超时时间（分钟）。

max_auth_retries

整数

SSH 会话失败时的重试次数。

max_sessions

整数

SSH 会话数。

port_number

整数

SSH 服务的端口号。

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: Update network services settings of a chassis using the device ID
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id: 25011
    snmp_settings:
      enabled: true
      port_number: 161
      community_name: public
    ssh_settings:
      enabled: false
    remote_racadm_settings:
      enabled: false

- name: Update network services settings of a chassis using the device service tag.
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.2"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag: GHRT2RL
    snmp_settings:
      enabled: false
    ssh_settings:
      enabled: true
      port_number: 22
      max_sessions: 1
      max_auth_retries: 3
      idle_timeout: 1
    remote_racadm_settings:
      enabled: false

- name: Update network services settings of the host chassis.
  dellemc.openmanage.ome_device_network_services:
    hostname: "192.168.0.3"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    snmp_settings:
      enabled: false
    ssh_settings:
      enabled: false
    remote_racadm_settings:
      enabled: true

返回值

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

键

描述

error_info

字典

HTTP 错误的详细信息。

返回： HTTP 错误时

示例： {"error": {"@Message.ExtendedInfo": [{"Message": "无法更新网络配置，因为 SNMP 端口号已被占用。", "MessageArgs": ["SNMP 端口号"], "MessageId": "CAPP1042", "RelatedProperties": [], "Resolution": "输入不同的端口号并重试操作。", "Severity": "Informational"}], "code": "Base.1.0.GeneralError", "message": "发生一般错误。有关详细信息，请参阅 ExtendedInfo。"}}

msg

字符串

网络服务设置的总体状态。

返回： 始终

示例： "成功更新了网络服务设置。"

network_services_details

字典

当网络服务设置成功更新时返回。

返回： 成功

示例： {"EnableRemoteRacadm": true, "SettingType": "NetworkServices", "SnmpConfiguration": {"PortNumber": 161, "SnmpEnabled": true, "SnmpV1V2Credential": {"CommunityName": "public"}}, "SshConfiguration": {"IdleTimeout": 60, "MaxAuthRetries": 3, "MaxSessions": 1, "PortNumber": 22, "SshEnabled": false}}

作者

  • Felix Stephen (@felixs88)