community.vmware.vmware_host_iscsi 模块 – 管理 ESXi 主机的 iSCSI 配置

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在剧本中使用它，请指定：community.vmware.vmware_host_iscsi。

概要

• 此模块可以管理 ESXi 主机的 iSCSI 配置

参数

参数	注释
esxi_hostname 字符串 / 必需	要更改其 iSCSI 设置的 ESXi 主机名。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 VMWARE_HOST 的值。
iscsi_config 字典	iSCSI 配置。 如果 state=present 或 state=absent，则此参数为必需。
alias 字符串	适配器别名的新的值。 默认值： ""
authentication 字典	iSCSI 的 CHAP 身份验证父级设置。
chap_auth_enabled 布尔值	是否启用 CHAP 身份验证。 选项 false ← (默认) true
chap_authentication_type 字符串	如果启用了 CHAP，则为 CHAP 或 CHAP 的非 CHAP 协议的偏好。 选项 "chapDiscouraged" "chapPreferred" "chapRequired" "chapProhibited" ← (默认)
chap_name 字符串	如果启用了 CHAP，则为 CHAP 用户名。 默认值： ""
chap_secret 字符串	如果启用了 CHAP，则为 CHAP 的秘密密码。
mutual_chap_authentication_type 字符串	如果启用了 CHAP，则为 Mutual-CHAP 的 CHAP 或非 CHAP 协议的偏好。 选项 "chapProhibited" ← (默认) "chapRequired"
mutual_chap_name 字符串	如果启用了 Mutual-CHAP，则目标需要用来向发起方进行身份验证的用户名。 默认值： ""
mutual_chap_secret 字符串	如果启用了 Mutual-CHAP，则为 Mutual-CHAP 的秘密密码。
force 布尔值	强制删除端口绑定 VMkernel。 选项 false ← (默认) true
iscsi_name 别名：initiator_iqn 字符串	iSCSI HBA 适配器的名称。 这是 iSCSI 限定名。
port_bind 列表 / 元素=字符串	如果使用端口绑定，则为 VMkernel 列表。 默认值： []
send_target 字典	iSCSI 动态目标设置。
address 字符串 / 必需	存储设备的 IP 地址或主机名。
authentication 字典	iSCSI 动态目标的 CHAP 身份验证设置。
chap_auth_enabled 布尔值	是否启用 CHAP 身份验证。 选项 false ← (默认) true
chap_authentication_type 字符串	如果启用了 CHAP，则为 CHAP 或 CHAP 的非 CHAP 协议的偏好。 选项 "chapDiscouraged" "chapPreferred" "chapRequired" "chapProhibited" ← (默认)
chap_inherited 布尔值	是否继承父级设置中的 CHAP 设置。 选项 false true ← (默认)
chap_name 字符串	如果启用了 CHAP，则为 CHAP 用户名。 默认值： ""
chap_secret 字符串	如果启用了 CHAP，则为 CHAP 的秘密密码。
mutual_chap_authentication_type 字符串	如果启用了 CHAP，则为 Mutual-CHAP 的 CHAP 或非 CHAP 协议的偏好。 选项 "chapProhibited" ← (默认) "chapRequired"
mutual_chap_inherited 布尔值	是否继承父级设置中的 Mutual-CHAP 设置。 选项 false true ← (默认)
mutual_chap_name 字符串	如果启用了 Mutual-CHAP，则目标需要用来向发起方进行身份验证的用户名。 默认值： ""
mutual_chap_secret 字符串	如果启用了 Mutual-CHAP，则为 Mutual-CHAP 的秘密密码。
port 整数	存储设备的 TCP 端口。 如果未指定，则使用标准默认值 3260。 默认值： 3260
static_target 字典	iSCSI 静态目标设置。
address 字符串 / 必需	存储设备的 IP 地址或主机名。
authentication 字典	iSCSI 静态目标的 CHAP 身份验证设置。
chap_auth_enabled 布尔值	是否启用 CHAP 身份验证。 选项 false ← (默认) true
chap_authentication_type 字符串	如果启用了 CHAP，则为 CHAP 或 CHAP 的非 CHAP 协议的偏好。 选项 "chapDiscouraged" "chapPreferred" "chapRequired" "chapProhibited" ← (默认)
chap_inherited 布尔值	是否继承父级设置中的 CHAP 设置。 选项 false true ← (默认)
chap_name 字符串	如果启用了 CHAP，则为 CHAP 用户名。 默认值： ""
chap_secret 字符串	如果启用了 CHAP，则为 CHAP 的秘密密码。
mutual_chap_authentication_type 字符串	如果启用了 CHAP，则为 Mutual-CHAP 的 CHAP 或非 CHAP 协议的偏好。 选项 "chapProhibited" ← (默认) "chapRequired"
mutual_chap_inherited 布尔值	是否继承父级设置中的 Mutual-CHAP 设置。 选项 false true ← (默认)
mutual_chap_name 字符串	如果启用了 Mutual-CHAP，则目标需要用来向发起方进行身份验证的用户名。 默认值： ""
mutual_chap_secret 字符串	如果启用了 Mutual-CHAP，则为 Mutual-CHAP 的秘密密码。
iscsi_name 字符串 / 必需	要连接到的 iSCSI 目标的名称。
port 整数	存储设备的 TCP 端口。 如果未指定，则使用标准默认值 3260。 默认值： 3260
vmhba_name 字符串 / 必需	iSCSI 适配器名称。
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定此值，则将使用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定此值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定此值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定值，则将使用环境变量VMWARE_PROXY_PORT的值。
状态 字符串	如果设置为present，则添加 iSCSI 目标或绑定端口（如果它们不存在）。 如果设置为present，则如果 iSCSI 设置已存在并发生更改，则更新它们。 如果设置为absent，则删除 iSCSI 目标或绑定端口（如果它们存在）。 如果设置为enabled，则如果 iSCSI 已禁用，则启用 ESXi 的 iSCSI。 如果设置为disabled，则如果 iSCSI 已启用，则禁用 ESXi 的 iSCSI。 选项 "present" ← (默认) "absent" "enabled" "disabled"
用户名 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定值，则将使用环境变量VMWARE_USER的值。
验证证书 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为false。 如果任务中未指定值，则将使用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

注释

注意

• 所有模块都需要 API 写入访问权限，因此在免费 ESXi 许可证上不受支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Enable iSCSI of ESXi
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    state: enabled

- name: Add a dynamic target to iSCSI config of ESXi
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    iscsi_config:
      vmhba_name: vmhba65
      send_target:
        address: "{{ send_target_address }}"
    state: present

- name: Add a static target to iSCSI config of ESXi
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    iscsi_config:
      vmhba_name: vmhba65
      static_target:
        iscsi_name: iqn.2011-08.com.xxxxxxx:as6104t-8c3e9d.target001
        address: "{{ send_target_address }}"
    state: present

- name: Add VMKernels to iSCSI config of ESXi
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    iscsi_config:
      vmhba_name: vmhba65
      port_bind:
        - vmk0
        - vmk1
    state: present

- name: Use CHAP authentication
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    iscsi_config:
      vmhba_name: vmhba65
      authentication:
        chap_auth_enabled: true
        chap_authentication_type: chapPreferred
        chap_name: chap_user_name
        chap_secret: secret
    state: present

- name: Remove a dynamic target from iSCSI config of ESXi
  community.vmware.vmware_host_iscsi:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    iscsi_config:
      vmhba_name: vmhba65
      send_target:
        address: "{{ send_target_address }}"
    state: absent

返回值

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

键

描述

iscsi_properties 字典

更改系统默认配置时返回的参数。 返回：已更改 示例：{"iscsi_alias": "", "iscsi_authentication_properties": {"_vimtype": "vim.host.InternetScsiHba.AuthenticationProperties", "chapAuthEnabled": false, "chapAuthenticationType": "chapProhibited", "chapInherited": null, "chapName": "", "chapSecret": "XXXXXXXXXXXXXXXXXXXXX", "mutualChapAuthenticationType": "chapProhibited", "mutualChapInherited": null, "mutualChapName": "XXXXXXXXXXXXXXXXXXXXX", "mutualChapSecret": ""}, "iscsi_enabled": true, "iscsi_name": "", "iscsi_send_targets": [], "iscsi_static_targets": [], "port_bind": [], "vmhba_name": "vmhba65"}

作者

• sky-joker (@sky-joker)

集合链接

• 问题跟踪器
• 主页
• 代码库 (源代码)