community.general.open_iscsi 模块 – 使用 Open-iSCSI 管理 iSCSI 目标

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，请参阅 需求 以了解详情。

要在 playbook 中使用它，请指定： community.general.open_iscsi。

概要

  • 发现给定门户上的目标，（断开/连接）目标，将目标标记为手动或自动启动，返回已连接目标的设备节点。

需求

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

  • open_iscsi 库和工具 (iscsiadm)

参数

参数

注释

auto_node-startup

别名：automatic

布尔值

目标节点是否应在启动时自动连接。

选项

  • false

  • true

auto_portal_startup

布尔值

在 community.general 3.2.0 中添加

目标节点门户是否应在启动时自动连接。

选项

  • false

  • true

discover

布尔值

是否应（重新）发现门户上的目标节点列表并将其添加到持久性 iSCSI 数据库。

请记住，iscsiadm 发现会重置配置，例如 node.startup 为手动，因此与 auto_node_startup=true 组合使用将始终返回已更改的状态。

选项

  • false ← (默认)

  • true

login

别名：state

布尔值

目标节点是否应连接。

当省略 target 时，将登录到所有可用目标。

选项

  • false

  • true

node_auth

字符串

node.session.auth.authmethod 的值。

默认值： "CHAP"

node_pass

字符串

node.session.auth.password 的值。

node_pass_in

字符串

在 community.general 3.8.0 中添加

node.session.auth.password_in 的值。

node_user

字符串

node.session.auth.username 的值。

node_user_in

字符串

在 community.general 3.8.0 中添加

node.session.auth.username_in 的值。

port

字符串

iSCSI 目标进程侦听的端口。

默认值： "3260"

portal

别名：ip

字符串

iSCSI 目标的域名或 IP 地址。

rescan

布尔值

在 community.general 4.1.0 中添加

重新扫描已建立的会话以发现新的目标。

当省略 target 时，将重新扫描所有会话。

选项

  • false ← (默认)

  • true

show_nodes

布尔值

模块是否应返回持久性 iSCSI 数据库中的节点列表。

选项

  • false ← (默认)

  • true

target

别名：name, targetname

字符串

iSCSI 目标名称。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回关于已更改内容（或可能需要在check_mode中更改的内容）的详细信息。

示例

- name: Perform a discovery on sun.com and show available target nodes
  community.general.open_iscsi:
    show_nodes: true
    discover: true
    portal: sun.com

- name: Perform a discovery on 10.1.2.3 and show available target nodes
  community.general.open_iscsi:
    show_nodes: true
    discover: true
    ip: 10.1.2.3

- name: Discover targets on portal and login to the ones available
  community.general.open_iscsi:
    portal: '{{ iscsi_target }}'
    login: true
    discover: true

- name: Connect to the named target, after updating the local persistent database (cache)
  community.general.open_iscsi:
    login: true
    target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d

- name: Disconnect from the cached named target
  community.general.open_iscsi:
    login: false
    target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d

- name: Override and disable automatic portal login on specific portal
  community.general.open_iscsi:
    login: false
    portal: 10.1.1.250
    auto_portal_startup: false
    target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d

- name: Rescan one or all established sessions to discover new targets (omit target for all sessions)
  community.general.open_iscsi:
    rescan: true
    target: iqn.1986-03.com.sun:02:f8c1f9e0-c3ec-ec84-c9c9-8bfb0cd5de3d

作者

  • Serge van Ginderachter (@srvg)