community.vmware.vmware_host_iscsi модуль — Управление настройками iSCSI хоста ESXi

Примечание

Этот модуль входит в коллекцию community.vmware (версия 4.7.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_host_iscsi.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

В этом модуле можно управлять настройками iSCSI хоста ESXi

Параметры

Параметр	Комментарии
esxi_hostname строка / обязательно	Имя хоста ESXi, на котором нужно изменить настройки iSCSI.
hostname строка	Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST` вместо него.
iscsi_config словарь	Настройки iSCSI. Этот параметр требуется, если `state=present` или `state=absent`.
alias строка	Новое значение для псевдонима адаптера. По умолчанию: `""`
authentication словарь	Настройки аутентификации CHAP для iSCSI.
chap_auth_enabled булево	Включить аутентификацию CHAP. Варианты: `false` ← (по умолчанию) `true`
chap_authentication_type строка	Предпочтение протокола CHAP или без CHAP, если CHAP включен. Варианты: `"chapDiscouraged"` `"chapPreferred"` `"chapRequired"` `"chapProhibited"` ← (по умолчанию)
chap_name строка	Имя пользователя CHAP, если CHAP включен. По умолчанию: `""`
chap_secret строка	Секретный пароль CHAP, если CHAP включен.
mutual_chap_authentication_type строка	Предпочтение протокола CHAP или без CHAP, если включен Mutual-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 словарь	Настройки аутентификации CHAP динамической цели для iSCSI.
chap_auth_enabled булево	Включить аутентификацию CHAP. Варианты: `false` ← (по умолчанию) `true`

chap_authentication_type string	Настройка протокола CHAP или без CHAP, если CHAP включен. Варианты: `"chapDiscouraged"` `"chapPreferred"` `"chapRequired"` `"chapProhibited"` ← (default)
chap_inherited boolean	Наследовать ли настройки CHAP из родительских настроек. Варианты: `false` `true` ← (default)
chap_name string	Имя пользователя CHAP, если CHAP включен. По умолчанию: `""`
chap_secret string	Секретный пароль CHAP, если CHAP включен.
mutual_chap_authentication_type string	Настройка протокола CHAP или без CHAP для Mutual-CHAP, если CHAP включен. Варианты: `"chapProhibited"` ← (default) `"chapRequired"`
mutual_chap_inherited boolean	Наследовать ли настройки Mutual-CHAP из родительских настроек. Варианты: `false` `true` ← (default)
mutual_chap_name string	Имя пользователя, которое целевой объект должен использовать для аутентификации с инициатором, если Mutual-CHAP включен. По умолчанию: `""`
mutual_chap_secret string	Секретный пароль mutual CHAP, если Mutual-CHAP включен.
port integer	TCP-порт устройства хранения. Если не указано, используется стандартное значение по умолчанию 3260. По умолчанию: `3260`
static_target dictionary	Настройки статической цели iSCSI.
address string / required	IP-адрес или имя хоста устройства хранения.
authentication dictionary	Настройки аутентификации CHAP для статической цели iSCSI.
chap_auth_enabled boolean	Включить ли аутентификацию CHAP. Варианты: `false` ← (default) `true`
chap_authentication_type string	Настройка протокола CHAP или без CHAP, если CHAP включен. Варианты: `"chapDiscouraged"` `"chapPreferred"` `"chapRequired"` `"chapProhibited"` ← (default)
chap_inherited boolean	Наследовать ли настройки CHAP из родительских настроек. Варианты: `false` `true` ← (default)
chap_name string	Имя пользователя CHAP, если CHAP включен. По умолчанию: `""`
chap_secret string	Секретный пароль CHAP, если CHAP включен.
mutual_chap_authentication_type string	Настройка протокола CHAP или без CHAP для Mutual-CHAP, если CHAP включен. Варианты: `"chapProhibited"` ← (default) `"chapRequired"`

mutual_chap_inherited boolean	Наследовать ли настройки Mutual-CHAP из родительских настроек. Варианты: `false` `true` ← (по умолчанию)
mutual_chap_name string	Имя пользователя, которое целевой ресурс должен использовать для аутентификации с инициатором, если включен Mutual-CHAP. По умолчанию: `""`
mutual_chap_secret string	Секретный пароль взаимной аутентификации CHAP, если Mutual-CHAP включен.
iscsi_name string / обязательно	Имя целевого ресурса iSCSI для подключения.
port integer	TCP-порт устройства хранения. Если не указан, используется стандартное значение по умолчанию 3260. По умолчанию: `3260`
vmhba_name string / обязательно	Имя адаптера iSCSI.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
state string	Если установлено значение `present`, добавить целевой ресурс iSCSI или порты привязки, если они не существуют. Если установлено значение `present`, обновить настройки iSCSI, если они уже существуют и произошли изменения. Если установлено значение `absent`, удалить целевой ресурс iSCSI или порты привязки, если они существуют. Если установлено значение `enabled`, включить iSCSI на ESXi, если iSCSI отключен. Если установлено значение `disabled`, отключить iSCSI на ESXi, если iSCSI включен. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"disabled"`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда сертификаты 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"}

Ключ

Описание

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)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_iscsi_module.html