Модуль hitachivantara.vspone_block.vsp.hv_vsp_one_server — управление серверами в системах хранения данных VSP E series, VSP One Block 20 series и VSP One Block 80 series.

Примечание

Этот модуль входит в коллекцию 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_vsp_one_server.

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

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

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

Модуль позволяет регистрировать, изменять и удалять серверы, а также выполнять различные операции с серверами.
Поддерживает различные операции с серверами в зависимости от указанного параметра state.
Использует Hitachi Virtual Storage Platform One Simple API для управления серверами в моделях VSP E series, VSP One B20 series и VSP One B80 series.
Примеры использования см. на странице https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_server.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Сведения, необходимые для подключения к системе хранения данных.
address строка / обязательный	IP-адрес или имя хоста системы хранения данных.
api_token строка	Токен для работы с заблокированными ресурсами.
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь / обязательный	Параметры конфигурации для операции с сервером.
hbas список / элементы=словарь	Список конфигураций HBA. Требуется для задач регистрации сервера FC с WWN HBA / регистрации сервера iSCSI с именами iSCSI / регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / регистрации зарезервированного сервера с заданной конфигурацией / добавления HBA к существующему серверу FC / добавления HBA iSCSI к существующему серверу iSCSI / удаления HBA с сервера FC / удаления HBA iSCSI с сервера iSCSI / регистрации сервера HP-UX с полным набором параметров конфигурации.
hba_wwn строка	Адрес WWN HBA. Требуется для задач регистрации сервера FC с WWN HBA / регистрации сервера с несколькими HBA и путями / регистрации зарезервированного сервера с заданной конфигурацией / добавления HBA к существующему серверу FC / удаления HBA с сервера FC / регистрации сервера HP-UX с полным набором параметров конфигурации.
iscsi_name строка	Имя iSCSI. Требуется для задач регистрации сервера iSCSI с именами iSCSI / регистрации сервера iSCSI с несколькими HBA и путями / добавления HBA iSCSI к существующему серверу iSCSI / удаления HBA iSCSI с сервера iSCSI.
host_groups список / элементы=словарь	Список конфигураций групп хостов. Требуется для задач регистрации сервера с группами хостов / добавления групп хостов к существующему серверу / регистрации сервера HP-UX с полным набором параметров конфигурации.
host_group_id целое число	Идентификатор группы хостов.
host_group_name строка	Имя группы хостов. Требуется для задач регистрации сервера с группами хостов / добавления групп хостов к существующему серверу / регистрации сервера HP-UX с полным набором параметров конфигурации.
port_id строка	Идентификатор порта. Требуется для задач регистрации сервера с группами хостов / добавления групп хостов к существующему серверу / регистрации сервера HP-UX с полным набором параметров конфигурации.
is_reserved логическое значение	Указывает, зарезервирован ли сервер. Требуется для задач регистрации базового сервера с минимальной конфигурацией / регистрации зарезервированного сервера с заданной конфигурацией. Варианты: `false` `true`
iscsi_target_settings список / элементы=словарь	Список конфигураций целей iSCSI. Требуется для задач изменения настроек цели iSCSI существующего сервера.
port_id строка / обязательный	Идентификатор порта. Требуется для задачи изменения настроек цели iSCSI существующего сервера.
target_iscsi_name строка / обязательный	Имя цели iSCSI. Требуется для задачи изменения настроек цели iSCSI существующего сервера.
iscsi_targets список / элементы=словарь	Список конфигураций целей iSCSI.
iscsi_target_id целое число	Идентификатор цели iSCSI.
iscsi_target_name строка	Имя цели iSCSI.
port_id строка	Идентификатор порта.
keep_lun_config логическое значение	Сохранять ли конфигурацию LUN. Требуется для задач регистрации сервера HP-UX с полным набором параметров конфигурации / удаления сервера по server_id с сохранением конфигурации LUN. Варианты: `false` `true`
nickname псевдонимы: nick_name строка	Псевдоним сервера. Требуется для задач регистрации базового сервера с минимальной конфигурацией / регистрации сервера FC с WWN HBA / регистрации сервера iSCSI с именами iSCSI / регистрации сервера с группами хостов / регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / регистрации зарезервированного сервера с заданной конфигурацией / обновления псевдонима существующего сервера (с помощью server_id) / регистрации сервера HP-UX с полным набором параметров конфигурации / удаления сервера по псевдониму.
os_type строка	Тип операционной системы сервера. Требуется для задач регистрации базового сервера с минимальной конфигурацией / регистрации сервера FC с WWN HBA / регистрации сервера iSCSI с именами iSCSI / регистрации сервера с группами хостов / регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / регистрации зарезервированного сервера с заданной конфигурацией / обновления настроек существующего сервера, например параметров типа ОС, с помощью server_id / регистрации сервера HP-UX с полным набором параметров конфигурации. Варианты: `"Linux"` `"HP-UX"` `"Solaris"` `"AIX"` `"VMware"` `"Windows"`
os_type_options список / элементы=целое число	Список идентификаторов параметров типа ОС. Требуется для задач регистрации зарезервированного сервера с заданной конфигурацией / обновления настроек существующего сервера, например параметров типа ОС, с помощью server_id.
paths список / элементы=словарь	Список конфигураций путей. Требуется для задач регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / добавления пути к серверу / удаления пути с сервера / регистрации сервера HP-UX с полным набором параметров конфигурации.
hba_wwn строка	Адрес WWN HBA. Требуется для задач регистрации сервера с несколькими HBA и путями / добавления пути к серверу / удаления пути с сервера / регистрации сервера HP-UX с полным набором параметров конфигурации.
iscsi_name строка	Имя iSCSI. Требуется для задач регистрации сервера iSCSI с несколькими HBA и путями.
port_ids список / элементы=строка / обязательный	Список идентификаторов портов. Требуется для задач регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / добавления пути к серверу / удаления пути с сервера / регистрации сервера HP-UX с полным набором параметров конфигурации.
port_ids список / элементы=строка	Список идентификаторов портов.
protocol строка	Тип протокола сервера. Требуется для задач регистрации базового сервера с минимальной конфигурацией / регистрации сервера FC с WWN HBA / регистрации сервера iSCSI с именами iSCSI / регистрации сервера с группами хостов / регистрации сервера с несколькими HBA и путями / регистрации сервера iSCSI с несколькими HBA и путями / регистрации зарезервированного сервера с заданной конфигурацией / регистрации сервера HP-UX с полным набором параметров конфигурации. Варианты: `"FC"` `"iSCSI"`
server_id целое число	Идентификатор сервера. Требуется для задач обновления псевдонима существующего сервера (с помощью server_id) / обновления настроек существующего сервера, например параметров типа ОС, с помощью server_id / добавления групп хостов к существующему серверу / добавления HBA к существующему серверу FC / добавления HBA iSCSI к существующему серверу iSCSI / удаления HBA с сервера FC / удаления HBA iSCSI с сервера iSCSI / добавления пути к серверу / удаления пути с сервера / синхронизации псевдонима сервера / изменения настроек цели iSCSI существующего сервера / удаления сервера по server_id с сохранением конфигурации LUN.
state строка	Определяет тип операции с сервером. Доступны следующие варианты: `present`, `absent`, `sync_server_nick_name`, `sync_server_nickname`, `add_host_groups`, `add_hba`, `remove_hba`, `add_path` и `remove_path`. `sync_server_nick_name` будет объявлен устаревшим в пользу `sync_server_nickname`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"sync_server_nick_name"` `"sync_server_nickname"` `"add_host_groups"` `"add_hba"` `"remove_hba"` `"add_path"` `"remove_path"` `"change_iscsi_target_settings"`

Атрибуты

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

Примеры

- name: Register a FC server with HBA WWN
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "WebServer01"
      protocol: "FC"
      os_type: "Linux"
      hbas:
        - hba_wwn: "50060e8010203040"

- name: Register an iSCSI server with iSCSI name
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "DatabaseServer01"
      protocol: "iSCSI"
      os_type: "Windows"
      hbas:
        - iscsi_name: "iqn.1991-05.com.microsoft:server01"

- name: Register server with host groups configuration
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "VMwareCluster01"
      protocol: "FC"
      os_type: "VMware"
      host_groups:
        - host_group_name: "VMware_HG01"
          port_id: "CL1-A"
        - host_group_name: "VMware_HG02"
          port_id: "CL1-B"

- name: Register server with multiple HBAs and paths configuration
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "AppServer01"
      protocol: "FC"
      os_type: "Linux"
      hbas:
        - hba_wwn: "50060e8010203040"
        - hba_wwn: "50060e8010203041"
      paths:
        - port_ids: ["CL1-A", "CL1-B"]
          hba_wwn: "50060e8010203040"
        - port_ids: ["CL2-A", "CL2-B"]
          hba_wwn: "50060e8010203041"

- name: Register iSCSI server with multiple iSCSI names and paths
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "HybridServer01"
      protocol: "iSCSI"
      os_type: "Linux"
      hbas:
        - iscsi_name: "iqn.1991-05.com.example:server01-iscsi1"
        - iscsi_name: "iqn.1991-05.com.example:server01-iscsi2"
      paths:
        - port_ids: ["CL1-A"]
          iscsi_name: "iqn.1991-05.com.example:server01-iscsi1"
        - port_ids: ["CL1-B"]
          iscsi_name: "iqn.1991-05.com.example:server01-iscsi2"

- name: Update existing server nickname with server_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      nickname: "UpdatedServerName"

- name: Update existing server settings like os type os type options using server_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      os_type: "Windows"
      os_type_options: [1, 2]

- name: Add host groups to existing server
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: add_host_groups
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      host_groups:
        - host_group_name: "NewHostGroup01"
          port_id: "CL2-A"
- name: Add HBA to existing server using server_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: add_hba
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      hbas:
        - hba_wwn: "50060e8010203042"
- name: Remove HBA from server
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: remove_hba
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 12
      hbas:
        - hba_wwn: "50060e8010203042"

- name: Add path to server
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: add_path
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 12
      paths:
        - port_ids: ["CL1-C", "CL1-D"]
          hba_wwn: "50060e8010203040"

- name: Remove path from server
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: remove_path
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 12
      paths:
        - port_ids: ["CL1-C"]
          hba_wwn: "50060e8010203040"

- name: Sync server nickname with host group
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: sync_server_nickname
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123

- name: Register reserved server with specific configuration
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "ReservedServer01"
      protocol: "FC"
      os_type: "Solaris"
      is_reserved: true
      keep_lun_config: true
      os_type_options: [1, 2]

- name: Change the iSCSI target settings for existing server (change target name)
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: present
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      iscsi_targets:
        - port_id: "CL1-A"
          iscsi_target_name: "iqn.1992-04.com.hitachi:target01"
        - port_id: "CL1-B"
          iscsi_target_name: "iqn.1992-04.com.hitachi:target02"

- name: Delete server using server_id and keep lun configuration
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: absent
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 123
      keep_lun_config: true

- name: Delete server using nickname.
  hitachivantara.vspone_block.vsp.hv_vsp_one_server:
    state: absent
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "WebServer01"

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

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

Ключ	Описание
server dictionary	Информация о сервере, возвращаемая после выполнения операции Возвращается: всегда
compatibility string	Статус совместимости сервера Возвращается: всегда Пример: `""`
has_non_fullmesh_lu_paths boolean	Указывает, есть ли у сервера пути LU, не образующие полную mesh-сеть Возвращается: всегда Пример: `true`
has_unaligned_os_type_options boolean	Указывает, есть ли у сервера несогласованные параметры типа ОС Возвращается: всегда Пример: `true`
has_unaligned_os_types boolean	Указывает, есть ли у сервера несогласованные типы ОС Возвращается: всегда Пример: `true`
id integer	Идентификатор сервера Возвращается: всегда Пример: `13`
is_inconsistent boolean	Указывает, противоречива ли конфигурация сервера Возвращается: всегда Пример: `false`
is_reserved boolean	Указывает, зарезервирован ли сервер Возвращается: всегда Пример: `false`
modification_in_progress boolean	Указывает, выполняется ли изменение сервера Возвращается: всегда Пример: `false`
nickname string	Псевдоним сервера Возвращается: всегда Пример: `"WebServer414"`
number_of_paths integer	Количество путей, настроенных для сервера Возвращается: всегда Пример: `2`
number_of_volumes integer	Количество томов, подключенных к серверу Возвращается: всегда Пример: `1`
os_type string	Тип операционной системы сервера Возвращается: всегда Пример: `"Linux"`
os_type_options list / elements=integer	Список идентификаторов параметров типа ОС Возвращается: всегда Пример: `[68]`
paths list / elements=dictionary	Список конфигураций путей сервера Возвращается: всегда
hba_wwn string	Адрес WWN адаптера HBA Возвращается: всегда Пример: `"210003e08b0256f9"`
iscsi_name string	Имя iSCSI Возвращается: всегда Пример: `""`
port_ids list / elements=string	Список идентификаторов портов Возвращается: всегда Пример: `["CL1-A"]`
protocol string	Тип протокола сервера Возвращается: всегда Пример: `"FC"`
total_capacity integer	Общая емкость в ГБ Возвращается: всегда Пример: `50`
used_capacity 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_vsp_one_server_module.html