Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_host_iscsi — управление конфигурацией iSCSI узла ESXi

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_host_iscsi.

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет управлять конфигурацией iSCSI узла ESXi

Параметры

Параметр

Комментарии

esxi_hostname

string / обязательный

Имя хоста ESXi, на котором нужно изменить параметры iSCSI.

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

iscsi_config

dictionary

Параметры iSCSI.

Этот параметр обязателен, если state=present или state=absent.

alias

string

Новое значение псевдонима адаптера.

По умолчанию: ""

authentication

dictionary

Общие параметры аутентификации CHAP для iSCSI.

chap_auth_enabled

boolean

Включить ли аутентификацию CHAP.

Варианты:

  • false ← (по умолчанию)
  • true

chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP, если CHAP включен.

Варианты:

  • "chapDiscouraged"
  • "chapPreferred"
  • "chapRequired"
  • "chapProhibited" ← (по умолчанию)

chap_name

string

Имя пользователя CHAP, если CHAP включен.

По умолчанию: ""

chap_secret

string

Секретный пароль CHAP, если CHAP включен.

mutual_chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP для взаимного CHAP, если CHAP включен.

Варианты:

  • "chapProhibited" ← (по умолчанию)
  • "chapRequired"

mutual_chap_name

string

Имя пользователя, которое целевой объект должен использовать для аутентификации инициатора, если взаимный CHAP включен.

По умолчанию: ""

mutual_chap_secret

string

Секретный пароль взаимного CHAP, если взаимный CHAP включен.

force

boolean

Принудительно удалить привязанные к портам VMkernel.

Варианты:

  • false ← (по умолчанию)
  • true

iscsi_name

псевдонимы: initiator_iqn

string

Имя адаптера iSCSI HBA.

Это квалифицированное имя iSCSI.

port_bind

list / элементы=string

Список VMkernel, если используются привязки портов.

По умолчанию: []

send_target

dictionary

Параметры динамической цели iSCSI.

address

string / обязательный

IP-адрес или имя хоста устройства хранения данных.

authentication

dictionary

Параметры аутентификации CHAP для динамической цели iSCSI.

chap_auth_enabled

boolean

Включить ли аутентификацию CHAP.

Варианты:

  • false ← (по умолчанию)
  • true

chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP, если CHAP включен.

Варианты:

  • "chapDiscouraged"
  • "chapPreferred"
  • "chapRequired"
  • "chapProhibited" ← (по умолчанию)

chap_inherited

boolean

Наследовать ли параметры CHAP от общих параметров.

Варианты:

  • false
  • true ← (по умолчанию)

chap_name

string

Имя пользователя CHAP, если CHAP включен.

По умолчанию: ""

chap_secret

string

Секретный пароль CHAP, если CHAP включен.

mutual_chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP для взаимного CHAP, если CHAP включен.

Варианты:

  • "chapProhibited" ← (по умолчанию)
  • "chapRequired"

mutual_chap_inherited

boolean

Наследовать ли параметры взаимного CHAP от общих параметров.

Варианты:

  • false
  • true ← (по умолчанию)

mutual_chap_name

string

Имя пользователя, которое целевой объект должен использовать для аутентификации инициатора, если взаимный CHAP включен.

По умолчанию: ""

mutual_chap_secret

string

Секретный пароль взаимного CHAP, если взаимный CHAP включен.

port

integer

TCP-порт устройства хранения данных.

Если не указан, используется стандартный порт 3260.

По умолчанию: 3260

static_target

dictionary

Параметры статической цели iSCSI.

address

string / обязательный

IP-адрес или имя хоста устройства хранения данных.

authentication

dictionary

Параметры аутентификации CHAP для статической цели iSCSI.

chap_auth_enabled

boolean

Включить ли аутентификацию CHAP.

Варианты:

  • false ← (по умолчанию)
  • true

chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP, если CHAP включен.

Варианты:

  • "chapDiscouraged"
  • "chapPreferred"
  • "chapRequired"
  • "chapProhibited" ← (по умолчанию)

chap_inherited

boolean

Наследовать ли параметры CHAP от общих параметров.

Варианты:

  • false
  • true ← (по умолчанию)

chap_name

string

Имя пользователя CHAP, если CHAP включен.

По умолчанию: ""

chap_secret

string

Секретный пароль CHAP, если CHAP включен.

mutual_chap_authentication_type

string

Предпочитаемый протокол CHAP или без CHAP для взаимного CHAP, если CHAP включен.

Варианты:

  • "chapProhibited" ← (по умолчанию)
  • "chapRequired"

mutual_chap_inherited

boolean

Наследовать ли параметры взаимного CHAP от общих параметров.

Варианты:

  • false
  • true ← (по умолчанию)

mutual_chap_name

string

Имя пользователя, которое целевой объект должен использовать для аутентификации инициатора, если взаимный CHAP включен.

По умолчанию: ""

mutual_chap_secret

string

Секретный пароль взаимного CHAP, если взаимный CHAP включен.

iscsi_name

string / обязательный

Имя цели iSCSI для подключения.

port

integer

TCP-порт устройства хранения данных.

Если не указан, используется стандартный порт 3260.

По умолчанию: 3260

vmhba_name

string / обязательный

Имя адаптера iSCSI.

password

псевдонимы: pass, pwd

string

Пароль сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды 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, если он отключен.

Если задано значение disabled, отключить iSCSI на ESXi, если он включен.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "enabled"
  • "disabled"

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.

validate_certs

boolean

Разрешает подключение, если SSL-сертификаты недействительны. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Всем модулям необходим доступ к API на запись, поэтому они не поддерживаются в бесплатной лицензии ESXi.
  • Имена всех переменных и объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не обращается к системному хранилищу сертификатов. Указать хранилище сертификатов можно с помощью переменной среды REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях значение ‘false’ параметра ‘validate_certs’ может быть проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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)

Ссылки на коллекцию

  • Трекер проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API