Модуль hitachivantara.vspone_block.vsp.hv_iscsi_target — управление целями iSCSI в системах блочного хранения VSP.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_iscsi_target.

Добавлено в hitachivantara.vspone_block 3.0.0

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

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

Модуль hv_iscsi_target предоставляет следующие операции управления целями iSCSI
1. Создание цели iSCSI
1. Обновление режима хоста и параметров режима хоста
1. Добавление инициатора IQN к цели iSCSI
1. Добавление LDEV к цели iSCSI
1. Удаление инициатора IQN из цели iSCSI
1. Удаление LDEV из цели iSCSI
1. Удаление цели iSCSI
1. Добавление пользователя CHAP к цели iSCSI
1. Удаление пользователя CHAP из цели iSCSI
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/iscsi_target.yml

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для подключения к системе хранения.
address строка / обязательный	IP-адрес или имя хоста системы хранения.
api_token строка	Токен для работы с заблокированными ресурсами.
connection_type строка	Тип подключения к системе хранения. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь / обязательный	Спецификация операции с целью iSCSI.
chap_users список / элементы=словарь	Список пользователей CHAP, которых нужно добавить или удалить. Необязателен для задачи создания цели iSCSI. Обязателен для задач добавления пользователей CHAP к цели iSCSI и удаления пользователя CHAP из цели iSCSI.
host_mode строка	Режим хоста группы хостов. Обязателен для задачи обновления режима хоста цели iSCSI и параметров режима хоста. Варианты: `"LINUX"` `"VMWARE"` `"HP"` `"OPEN_VMS"` `"TRU64"` `"SOLARIS"` `"NETWARE"` `"WINDOWS"` `"HI_UX"` `"AIX"` `"VMWARE_EXTENSION"` `"WINDOWS_EXTENSION"` `"UVM"` `"HP_XP"` `"DYNIX"`
host_mode_options список / элементы=целое число	Список номеров параметров режима хоста группы хостов. Обязателен для задачи обновления режима хоста цели iSCSI и параметров режима хоста. 0 # ЗАРЕЗЕРВИРОВАНО 2 # VERITAS_DB_EDITION_ADV_CLUSTER 6 # TPRLO 7 # AUTO_LUN_RECOGNITION 12 # NO_DISPLAY_FOR_GHOST_LUN 13 # SIM_REPORT_AT_LINK_FAILURE 14 # HP_TRUECLUSTER_WITH_TRUECOPY 15 # RAID_HACMP 22 # VERITAS_CLUSTER_SERVER 23 # REC_COMMAND_SUPPORT 25 # SUPPORT_SPC_3_PERSISTENT_RESERVATION 33 # SET_REPORT_DEVICE_ID_ENABLE 39 # CHANGE_NEXUS_SPECIFIED_IN_SCSI_TARGET_RESET 40 # VVOL_EXPANSION 41 # PRIORITIZED_DEVICE_RECOGNITION 42 # PREVENT_OHUB_PCI_RETRY 43 # QUEUE_FULL_RESPONSE 48 # HAM_SVOL_READ 49 # BB_CREDIT_SETUP_1 50 # BB_CREDIT_SETUP_2 51 # ROUND_TRIP_SETUP 52 # HAM_AND_CLUSTER_SW_FOR_SCSI_2 54 # EXTENDED_COPY 57 # HAM_RESPONSE_CHANGE 60 # LUN0_CHANGE_GUARD 61 # EXPANDED_PERSISTENT_RESERVE_KEY 63 # VSTORAGE_APIS_ON_T10_STANDARDS 65 # ROUND_TRIP_EXTENDED_SETUP 67 # CHANGE_OF_ED_TOV_VALUE 68 # PAGE_RECLAMATION_LINUX 69 # ONLINE_LUSE_EXPANSION 71 # CHANGE_UNIT_ATTENTION_FOR_BLOCKED_POOL_VOLS 72 # AIX_GPFS 73 # WS2012 78 # NON_PREFERRED_PATH 91 # DISABLE_IO_WAIT_FOR_OPEN_STACK 95 # CHANGE_SCSI_LU_RESET_NEXUS_VSP_HUS_VM 96 # CHANGE_SCSI_LU_RESET_NEXUS 97 # PROPRIETARY_ANCHOR_COMMAND_SUPPORT 100 # HITACHI_HBA_EMULATION_CONNECTION_OPTION 102 # GAD_STANDARD_INQURY_EXPANSION_HCS 105 # TASK_SET_FULL_RESPONSE_FOR_IO_OVERLOAD 110 # Поддержка ODX для WS2012 113 # Журнал аутентификации iSCSI CHAP 114 # Автоматическое асинхронное освобождение пространства в ESXi 6.5+ 122 # TASK_SET_FULL_RESPONSE_AFTER_QOS_UPPER_LIMIT 124 # GUARANTEED_RESPONSE_DURING_CONTROLLER_FAILURE 131 # WCE_BIT_OFF_MODE
iqn_initiators список / элементы=словарь	Список инициаторов IQN, которых нужно добавить или удалить. Необязателен для задач создания цели iSCSI и переименования или удаления псевдонима инициатора IQN (существующего инициатора IQN). Обязателен для задач добавления инициаторов IQN к цели iSCSI и удаления инициаторов IQN из цели iSCSI.
iqn строка / обязательный	IQN инициатора. Обязателен для задач создания цели iSCSI, добавления инициаторов IQN к цели iSCSI, удаления инициаторов IQN из цели iSCSI и переименования или удаления псевдонима инициатора IQN (существующего инициатора IQN).
nickname псевдонимы: nick_name строка	Псевдоним инициатора. Обязателен для задач создания цели iSCSI, добавления инициаторов IQN к цели iSCSI и переименования или удаления псевдонима инициатора IQN (существующего инициатора IQN).
iscsi_id целое число	Идентификатор цели iSCSI.
ldevs список / элементы=строка	Идентификатор LDEV в десятичном или шестнадцатеричном формате для LDEV, который нужно представить или скрыть. Необязателен для задачи создания цели iSCSI. Обязателен для задач подключения LDEV к цели iSCSI и отключения LDEV от цели iSCSI.
lun целое число	Идентификатор LUN для снятия состояния резервирования хоста. Обязателен для задачи снятия резервирования хоста с LU, сопоставленного с указанным путем сопоставления LU.
name строка	Имя цели iSCSI. Если имя не указано, оно будет создано с префиксом «smrha-<10-значное случайное число>». Необязательно для задачи создания цели iSCSI. Обязательно для задач обновления режима хоста цели iSCSI и параметров режима хоста, добавления пользователей CHAP к цели iSCSI, удаления пользователя CHAP из цели iSCSI, добавления инициаторов IQN к цели iSCSI, удаления инициаторов IQN из цели iSCSI, подключения LDEV к цели iSCSI, отключения LDEV от цели iSCSI, удаления цели iSCSI, переименования или удаления псевдонима инициатора IQN (существующего инициатора IQN), снятия резервирования хоста с LU, сопоставленного со всеми путями сопоставления LU, и снятия резервирования хоста с LU, сопоставленного с указанным путем сопоставления LU.
port_id псевдонимы: port строка / обязательный	Идентификатор порта цели iSCSI. Обязателен для задач создания цели iSCSI, обновления режима хоста цели iSCSI и параметров режима хоста, добавления пользователей CHAP к цели iSCSI, удаления пользователя CHAP из цели iSCSI, добавления инициаторов IQN к цели iSCSI, удаления инициаторов IQN из цели iSCSI, подключения LDEV к цели iSCSI, отключения LDEV от цели iSCSI, удаления цели iSCSI, переименования или удаления псевдонима инициатора IQN (существующего инициатора IQN), снятия резервирования хоста с LU, сопоставленного со всеми путями сопоставления LU, и снятия резервирования хоста с LU, сопоставленного с указанным путем сопоставления LU.
should_delete_all_volumes псевдонимы: should_delete_all_ldevs логическое значение	Если значение равно true, уничтожить логические устройства, больше не подключенные ни к одной цели iSCSI. Варианты: `false` `true`
should_release_host_reserve логическое значение	Если значение равно true, снять резервирование хоста. Обязателен для задач снятия резервирования хоста с LU, сопоставленного со всеми путями сопоставления LU, и снятия резервирования хоста с LU, сопоставленного с указанным путем сопоставления LU. Варианты: `false` `true`
state строка	Состояние задач с целями iSCSI. `present` — обновить цель iSCSI, переопределив режим хоста и его параметр, а также добавив остальные параметры, указанные в spec. `absent` — обновить цель iSCSI, удалив все параметры, указанные в spec. `add_iscsi_initiator` — обновить цель iSCSI, добавив все инициаторы IQN, указанные в spec. `remove_iscsi_initiator` — обновить цель iSCSI, удалив все инициаторы IQN, указанные в spec. `attach_ldev` — обновить цель iSCSI, добавив все LDEV, указанные в spec. `detach_ldev` — обновить цель iSCSI, удалив все LDEV, указанные в spec. `add_chap_user` — обновить цель iSCSI, добавив всех пользователей CHAP, указанных в spec. `remove_chap_user` — обновить цель iSCSI, удалив всех пользователей CHAP, указанных в spec. Варианты: `"present"` ← (по умолчанию) `"absent"` `"add_iscsi_initiator"` `"remove_iscsi_initiator"` `"attach_ldev"` `"detach_ldev"` `"add_chap_user"` `"remove_chap_user"`
state строка	Для создания и обновления цели iSCSI задайте state=presents. Для удаления цели iSCSI задайте state=absent. Варианты: `"present"` ← (по умолчанию) `"absent"`
storage_system_info словарь	Информация о системе хранения. Это необязательное поле.
serial строка	Серийный номер системы хранения.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Определяет, должен ли модуль работать в режиме проверки.

Примечания

Примечание

Выходные параметры subscriber_id и partner_id удалены в версии 3.4.0. Они также объявлены устаревшими в связи с упрощением внутреннего API и больше не поддерживаются.
Тип подключения gateway удален начиная с версии 3.4.0. Если требуется этот тип подключения, используйте более раннюю версию.

Примеры

- name: Create iscsi targets
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      name: 'iscsi-target-server-1'
      port_id: 'CL4-C'
      iqn_initiators:
        - iqn: iqn.1993-08.org.debian.iscsi:01:107dc7e4254a
          nickname: "nickname1"
        - iqn: iqn.1993-08.org.debian.iscsi:01:107dc7e4254b
          nickname: "nickname2"
      ldevs: [100, 200]
      chap_users:
        - chap_user_name: user1
          chap_secret: Secret1

- name: Update iscsi target host mode and options
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      name: 'iscsi-target-server-1'
      port_id: 'CL4-C'
      host_mode: LINUX
      host_mode_options: [54, 63]

- name: Add chap users to iscsi target
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      state: add_chap_user
      name: 'iscsi-target-server-1'
      port_id: 'CL4-C'
      chap_users:
        - chap_user_name: user1
          chap_secret: Secret1
        - chap_user_name: user2
          chap_secret: Secret2

- name: Remove chap user from iscsi target
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      state: remove_chap_user
      name: 'iscsi-target-server-1'
      port_id: 'CL4-C'
      chap_users:
        - chap_user_name: user2
          chap_secret: Secret2

- name: Add iqn initiators to iscsi target
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      state: add_iscsi_initiator
      name: 'iscsi-target-server-1'
      port_id: 'CL4-C'
      iqn_initiators:
        - iqn: iqn.1993-08.org.debian.iscsi:01:107dc7e4254b

- name: Release host reserve status of a iscsi target using lun
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      iscsi_id: 20
      should_release_host_reserve: true
      port_id: 'CL4-C'
      lun: 100

- name: Release host reserve status of a iscsi targets
  hitachivantara.vspone_block.vsp.hv_iscsi_target:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      iscsi_id: 20
      port_id: 'CL4-C'
      should_release_host_reserve: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
iscsi_target dictionary	Сведения о цели iSCSI. Возвращается: всегда
auth_param dictionary	Параметры аутентификации. Возвращается: при успешном выполнении
authentication_mode string	Режим аутентификации. Возвращается: при успешном выполнении Пример: `"BOTH"`
is_chap_enabled boolean	Указывает, включен ли CHAP. Возвращается: при успешном выполнении Пример: `true`
is_chap_required boolean	Указывает, требуется ли CHAP. Возвращается: при успешном выполнении Пример: `false`
is_mutual_auth boolean	Указывает, включена ли взаимная аутентификация. Возвращается: при успешном выполнении Пример: `false`
chap_users list / elements=string	Список пользователей CHAP. Возвращается: при успешном выполнении Пример: `[]`
host_mode dictionary	Сведения о режиме хоста. Возвращается: при успешном выполнении
host_mode string	Режим хоста. Возвращается: при успешном выполнении Пример: `"LINUX"`
host_mode_options list / elements=dictionary	Список параметров режима хоста. Возвращается: при успешном выполнении Пример: `[]`
iqn string	IQN цели iSCSI. Возвращается: при успешном выполнении Пример: `"iqn.1994-04.jp.co.hitachi:rsd.has.t.10050.4c0ee"`
iqn_initiators list / elements=dictionary	Список инициаторов IQN. Возвращается: при успешном выполнении
iqn string	IQN инициатора. Возвращается: при успешном выполнении Пример: `"iqn.1993-08.org.debian.iscsi:01:107dc7e4254a"`
nick_name string	Устарело. Используйте вместо этого `nickname`. Возвращается: при успешном выполнении Пример: `"iscsi-target-server-1"`
nickname string	Псевдоним инициатора. Возвращается: при успешном выполнении Пример: `"iscsi-target-1"`
iscsi_id integer	Идентификатор цели iSCSI. Возвращается: при успешном выполнении Пример: `238`
iscsi_name string	Имя цели iSCSI. Возвращается: при успешном выполнении Пример: `"isserver21"`
logical_units list / elements=dictionary	Список логических устройств. Возвращается: при успешном выполнении Пример: `[]`
port_id string	Идентификатор порта. Возвращается: при успешном выполнении Пример: `"CL4-C"`
resource_group_id integer	Идентификатор группы ресурсов. Возвращается: при успешном выполнении Пример: `0`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/vsp.hv_iscsi_target_module.html