dellemc.openmanage.idrac_virtual_media 模块 – 配置远程文件共享设置。

注意

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

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

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

要在剧本中使用它,请指定:dellemc.openmanage.idrac_virtual_media

dellemc.openmanage 6.3.0 中的新增功能

概要

  • 此模块允许配置远程文件共享设置。

需求

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

  • python >= 3.9.6

参数

参数

注释

ca_path

路径

dellemc.openmanage 5.0.0 中添加

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

force

布尔值

如果已连接,true 将弹出映像文件,并插入 *image* 中提供的文件。这适用于 *insert* 为 true 的情况。

选项

  • false ← (默认)

  • true

idrac_ip

字符串 / 必需

iDRAC IP 地址。

idrac_password

别名:idrac_pwd

字符串

iDRAC 用户密码。

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

示例:export IDRAC_PASSWORD=password

idrac_port

整数

iDRAC 端口。

默认值: 443

idrac_user

字符串

iDRAC 用户名。

如果未提供用户名,则使用环境变量 IDRAC_USERNAME

示例:export IDRAC_USERNAME=username

resource_id

字符串

iDRAC 的资源 ID,如果未指定,将使用管理器集合 ID。

timeout

整数

dellemc.openmanage 5.0.0 中添加

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

默认值: 30

validate_certs

布尔值

dellemc.openmanage 5.0.0 中添加

如果为 false,则不会验证 SSL 证书。

仅在使用自签名证书的个人控制站点上配置 false

在集合版本 5.0.0 之前,*validate_certs* 默认值为 false

选项

  • false

  • true ← (默认)

virtual_media

列表 / 元素=字典 / 必需

远程文件共享的详细信息。

domain

字符串

网络共享的域名。此选项适用于 CIFS 和 HTTPS 共享。

image

路径

映像文件的路径。支持的文件类型为 .img 和 .iso。

扩展名为 .img 的文件名将重定向为虚拟软盘,扩展名为 .iso 的文件名将重定向为虚拟 CDROM。

当 *insert* 为 true 时,此选项是必需的。

以下是共享位置的示例:CIFS 共享://192.168.0.1/file_path/image_name.iso,NFS 共享:192.168.0.2:/file_path/image_name.img,HTTP 共享:http://192.168.0.3/file_path/image_name.iso,HTTPS 共享:https://192.168.0.4/file_path/image_name.img

iDRAC8 不支持 CIFS 共享。

iDRAC8 不支持带有凭据的 HTTPS 共享。

index

整数

远程文件共享的索引。例如,要指定远程文件共享 1,则 *index* 的值应为 1。如果未指定 *index*,则将考虑 *virtual_media* 列表的顺序。

insert

布尔值 / 必需

true 连接远程映像文件。

false 弹出已连接的远程映像文件。

选项

  • false

  • true

media_type

字符串

映像文件的类型。这适用于 *insert* 为 true 的情况。

选项

  • "CD"

  • "DVD"

  • "USBStick"

password

字符串

网络共享密码。此选项适用于 CIFS 和 HTTPS 共享。

当提供 *password* 时,此模块始终报告为找到的更改。

username

字符串

网络共享用户名。此选项适用于 CIFS 和 HTTPS 共享。

x_auth_token

字符串

dellemc.openmanage 9.3.0 中添加

身份验证令牌。

如果未提供 x_auth_token,则使用环境变量 IDRAC_X_AUTH_TOKEN

示例:export IDRAC_X_AUTH_TOKEN=x_auth_token

注释

注意

  • 从此模块可以直接访问 Dell iDRAC 的系统运行此模块。

  • 此模块支持 check_mode

示例

---
- name: Insert image file to Remote File Share 1 using CIFS share.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    virtual_media:
      - insert: true
        image: "//192.168.0.2/file_path/file.iso"
        username: "username"
        password: "password"

- name: Insert image file to Remote File Share 2 using NFS share.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    virtual_media:
      - index: 2
        insert: true
        image: "192.168.0.4:/file_path/file.iso"

- name: Insert image file to Remote File Share 1 and 2 using HTTP.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    force: true
    virtual_media:
      - index: 1
        insert: true
        image: "http://192.168.0.4/file_path/file.img"
      - index: 2
        insert: true
        image: "http://192.168.0.4/file_path/file.img"

- name: Insert image file using HTTPS.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    force: true
    virtual_media:
      - index: 1
        insert: true
        image: "https://192.168.0.5/file_path/file.img"
        username: username
        password: password

- name: Eject multiple virtual media.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    force: true
    virtual_media:
      - index: 1
        insert: false
      - index: 2
        insert: false

- name: Ejection of image file from Remote File Share 1.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    force: true
    virtual_media:
      insert: false

- name: Insertion and ejection of image file in single task.
  dellemc.openmanage.idrac_virtual_media:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    force: true
    virtual_media:
      - index: 1
        insert: true
        image: https://192.168.0.5/file/file.iso
        username: username
        password: password
      - index: 2
        insert: false

返回值

公共返回值已在 此处 记录,以下是此模块特有的字段

描述

error_info

字典

HTTP 错误的详细信息。

返回:HTTP 错误时

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

消息

字符串

虚拟介质操作已成功执行。

返回:成功

示例: "虚拟介质操作已成功执行。"

作者

  • Felix Stephen (@felixs88)