Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_journal — создание и обновление журналов в системе хранения

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_journal.

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

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

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

Создание и обновление журналов в системе хранения.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sds_block_journal.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Информация, необходимая для установления соединения с системой хранения.
address string / обязательный	IP-адрес или имя узла системы хранения.
connection_type string	Тип соединения с системой хранения. Допустимые значения: `"direct"` ← (по умолчанию)
password string / обязательный	Пароль для аутентификации. Это обязательное поле.
username string / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec dictionary	Параметры журнала, который нужно добавить в систему хранения или обновить.
data_overflow_watch_in_sec integer	Время мониторинга переполнения данных (в секундах).
enable_cache_mode boolean	Указывает, следует ли включить режим кэширования. Допустимые значения: `false` `true`
enable_inflow_control boolean	Указывает, следует ли ограничить входящий поток операций ввода-вывода обновления для тома журнала (путём задержки ответа на операции ввода-вывода узла). Допустимые значения: `false` `true`
id string	Идентификатор журнала.
mirror_unit dictionary	Конфигурация зеркального устройства для журнала.
copy_pace string	Настройка скорости копирования для зеркального устройства. Допустимые значения: `"L"` `"M"` `"H"`
data_transfer_speed_bps string	Скорость передачи данных в байтах в секунду. Допустимые значения: `"3M"` `"10M"` `"100M"` `"256M"`
number integer / обязательный	Номер зеркального устройства.
number integer	Номер создаваемого или обновляемого журнала.
volume_ids list / elements=string	Список идентификаторов томов, которые нужно добавить в журнал.
vps_id string	Идентификатор целевого виртуального частного хранилища (VPS), для которого выполняется операция.
vps_name string	Имя целевого виртуального частного хранилища (VPS), для которого выполняется операция.
state string	Уровень задачи для журнала. Допустимые значения: `"present"` ← (по умолчанию) `"update"` `"absent"` `"shrink_journal"` `"expand_journal"`

Атрибуты

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

Примеры

- name: Creates a journal and adds a journal volume to the journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      number: 3
      volume_ids:
        - "537be416-6d0d-4da6-98cd-fccb76bb3451"
      data_overflow_watch_in_sec: 60
      enable_inflow_control: false
      enable_cache_mode: false
      vps_id: "system"
- name: Update a existing journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: ""
      number: 3
      data_overflow_watch_in_sec: 150
      enable_inflow_control: false
      enable_cache_mode: true
      vps_id: "system"
      vps_name: "system"
      mirror_unit:
        number: 0
        copy_pace: "M"
        data_transfer_speed_bps: "3M"

- name: Get journal info by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      id: "id-of-journal"
      number: 3

- name: Delete a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      id: "id-of-journal"
      number: 3

- name: Expand add volume to a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: expand_journal
    spec:
      id: "id-of-journal"
      number: 3
      volume_ids:
        - "ad58c370-7a55-4bd5-91ce-70ed71050835"
      vps_id: "system"
      vps_name: "system"

- name: Shrink (delete volume from) a journal
  hitachivantara.vspone_block.sds_block.hv_sds_block_journal:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: shrink_journal
    spec:
      id: "id-of-journal"
      number: 3
      volume_ids:
        - "1322e160-fac4-4ac7-9b71-5c1c1ea294ca"
      vps_id: "system"
      vps_name: "system"

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

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

Ключ	Описание
journals dictionary	Словарь со сведениями о журналах, обнаруженных в системе или управляемых в ней. Возвращается: всегда
data list / elements=dictionary	Список записей журнала. Возвращается: при успехе
block_capacity integer	Ёмкость блока журнала. Возвращается: при успехе Пример: `23068672`
capacity integer	Ёмкость журнала в мегабайтах или соответствующих единицах измерения. Возвращается: при успехе Пример: `11264`
data_overflow_watch_in_seconds integer	Пороговое значение (в секундах) для обнаружения переполнения данных в журнале. Возвращается: при успехе Пример: `60`
id string	Уникальный идентификатор журнала. Возвращается: при успехе Пример: `"551a8c21-caae-4d4f-8f5f-c4f3dbc5374f"`
is_cache_mode_enabled boolean	Указывает, включён ли режим кэширования для журнала. Возвращается: при успехе Пример: `true`
is_inflow_control_enabled boolean	Указывает, включено ли управление входящим потоком для журнала. Возвращается: при успехе Пример: `true`
journal_number integer	Номер журнала, назначенный системой. Возвращается: при успехе Пример: `0`
mirror_units list / elements=dictionary	Список зеркальных устройств, связанных с журналом. Возвращается: при успехе
consistency_group_id integer	Идентификатор группы согласованности, к которой относится зеркальное устройство. Возвращается: при успехе Пример: `-1`
copy_pace string	Настройка скорости копирования для зеркального устройства (например, L, M, H). Возвращается: при успехе Пример: `"L"`
copy_speed string	Настроенная скорость копирования для зеркального устройства. Возвращается: при успехе Пример: `"256M"`
journal_status string	Текущее состояние зеркального устройства. Возвращается: при успехе Пример: `"SMPL"`
mu_number integer	Номер зеркального устройства. Возвращается: при успехе Пример: `2`
number_of_active_paths string	Количество активных путей передачи данных для зеркального устройства. Возвращается: при успехе Пример: `""`
q_count string	Сведения о количестве элементов в очереди, если доступны. Возвращается: при успехе Пример: `""`
q_marker string	Сведения о маркере очереди, если доступны. Возвращается: при успехе Пример: `""`
status string	Текущее рабочее состояние журнала. Возвращается: при успехе Пример: `"Normal"`
storage_controller_id string	Идентификатор связанного контроллера хранения. Возвращается: при успехе Пример: `"f330c421-5c9b-4f3a-8b4f-12268053dc60"`
usage_rate string	Текущий уровень использования журнала. Возвращается: при успехе Пример: `""`
volume_ids list / elements=string	Список идентификаторов связанных томов журнала. Возвращается: при успехе Пример: `["2a0fa47c-2343-418b-b60f-18580cd86d67"]`
vps_id string	Идентификатор VPS, связанного с журналом. Возвращается: при успехе Пример: `"(system)"`
vps_name string	Имя VPS, связанного с журналом. Возвращается: при успехе Пример: `"(system)"`

Авторы

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/sds_block.hv_sds_block_journal_module.html