community.vmware.vmware_host_iscsi – Управление конфигурацией iSCSI хоста ESXi
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_host_iscsi.
Обзор
- В данном модуле можно управлять конфигурацией iSCSI хоста ESXi
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| esxi_hostname строка / обязательно | Имя хоста ESXi, на котором необходимо изменить настройки iSCSI. | ||||
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST.Поддержка переменных среды добавлена в Ansible 2.6. | ||||
| iscsi_config словарь | Настройки iSCSI. Этот параметр обязателен, если state=present или state=absent. | ||||
| alias строка | Значение по умолчанию: "" | Новое значение для алиаса адаптера. | |||
| authentication словарь | Настройки аутентификации CHAP для iSCSI. | ||||
| chap_auth_enabled логическое значение |
| Включить аутентификацию CHAP. | |||
| chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP, если CHAP включен. | |||
| chap_name строка | Значение по умолчанию: "" | Имя пользователя CHAP, если CHAP включен. | |||
| chap_secret строка | Секретный пароль CHAP, если CHAP включен. | ||||
| mutual_chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP для Mutual-CHAP, если CHAP включен. | |||
| mutual_chap_name строка | Значение по умолчанию: "" | Имя пользователя, которое целевой компьютер должен использовать для аутентификации с инициатором, если включен Mutual-CHAP. | |||
| mutual_chap_secret строка | Секретный пароль для Mutual-CHAP, если включен Mutual-CHAP. | ||||
| force логическое значение |
| Принудительно удалить VMkernels, привязанные к порту. | |||
| port_bind список / элементы=строка | Значение по умолчанию: [] | Список VMkernel, если используется привязка к порту. | |||
| send_target словарь | Настройки динамической цели iSCSI. | ||||
| address строка / обязательно | IP-адрес или имя хоста устройства хранения. | ||||
| authentication словарь | Настройки аутентификации CHAP динамической цели для iSCSI. | ||||
| chap_auth_enabled логическое значение |
| Включить аутентификацию CHAP. | |||
| chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP, если CHAP включен. | |||
| chap_inherited логическое значение |
| Наследовать настройки CHAP из родительских настроек. | |||
| chap_name строка | Значение по умолчанию: "" | Имя пользователя CHAP, если CHAP включен. | |||
| chap_secret строка | Секретный пароль CHAP, если CHAP включен. | ||||
| mutual_chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP для Mutual-CHAP, если CHAP включен. | |||
| mutual_chap_inherited логическое значение |
| Наследовать настройки Mutual-CHAP из родительских настроек. | |||
| mutual_chap_name строка | Значение по умолчанию: "" | Имя пользователя, которое целевой компьютер должен использовать для аутентификации с инициатором, если включен Mutual-CHAP. | |||
| mutual_chap_secret строка | Секретный пароль для Mutual-CHAP, если включен Mutual-CHAP. | ||||
| port целое число | Значение по умолчанию: 3260 | TCP-порт устройства хранения. Если не указано, используется стандартное значение по умолчанию 3260. | |||
| static_target словарь | Настройки статической цели iSCSI. | ||||
| address строка / обязательно | IP-адрес или имя хоста устройства хранения. | ||||
| authentication словарь | Настройки аутентификации CHAP статической цели для iSCSI. | ||||
| chap_auth_enabled логическое значение |
| Включить аутентификацию CHAP. | |||
| chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP, если CHAP включен. | |||
| chap_inherited логическое значение |
| Наследовать настройки CHAP из родительских настроек. | |||
| chap_name строка | Значение по умолчанию: "" | Имя пользователя CHAP, если CHAP включен. | |||
| chap_secret строка | Секретный пароль CHAP, если CHAP включен. | ||||
| mutual_chap_authentication_type строка |
| Предпочтение протокола CHAP или без CHAP для Mutual-CHAP, если CHAP включен. | |||
| mutual_chap_inherited логическое значение |
| Наследовать настройки Mutual-CHAP из родительских настроек. | |||
| mutual_chap_name строка | Значение по умолчанию: "" | Имя пользователя, которое целевой компьютер должен использовать для аутентификации с инициатором, если включен Mutual-CHAP. | |||
| mutual_chap_secret строка | Секретный пароль для Mutual-CHAP, если включен Mutual-CHAP. | ||||
| mutual_chap_name string | Default: "" | Имя пользователя, которое целевой объект должен использовать для аутентификации у инициатора, если включён Mutual-CHAP. | |||
| mutual_chap_secret string | Секретный пароль Mutual CHAP, если включён Mutual-CHAP. | ||||
| iscsi_name string / required | Имя iSCSI-цели для подключения. | ||||
| port integer | Default: 3260 | TCP-порт устройства хранения. Если не указано, используется стандартное значение по умолчанию 3260. | |||
| vmhba_name string / required | Имя адаптера iSCSI. | ||||
| password string | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | ||||
| port integer | Default: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. | |||
| proxy_host string | Адрес прокси-сервера, который будет получать все HTTPS-запросы и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | ||||
| proxy_port integer | Порт HTTP-прокси-сервера, который будет получать все HTTPS-запросы и пересылать их. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PROXY_PORT. | ||||
| state string |
| Если установлено значение present, добавить iSCSI-цель или порты привязки, если они отсутствуют.Если установлено значение present, обновить настройки iSCSI, если они уже существуют и произошли изменения.Если установлено значение absent, удалить iSCSI-цель или порты привязки, если они существуют.Если установлено (enabled), включить iSCSI в ESXi, если iSCSI выключен. Если установлено (disabled), выключить iSCSI в ESXi, если iSCSI включён. | |||
| username string | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | ||||
| validate_certs boolean |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите значение false, если сертификаты ненадёжны.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. | |||
Примеры
- 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 dictionary | changed | Возвращаемые параметры, когда изменены системные значения по умолчанию. Пример: { "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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_host_iscsi_module.html