Модуль dellemc.unity.snapshotschedule — управление расписаниями создания снимков в системе хранения Unity

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.1.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.unity.snapshotschedule.

Добавлено в dellemc.unity 1.1.0

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

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

Управление расписаниями создания снимков в системе хранения Unity включает создание нового расписания, получение сведений о расписании, изменение его атрибутов и удаление расписания.

Требования

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

Устройство Dell Unity Storage версии 5.3 или новее.
Ansible-core версии 2.17 или новее.
Python 3.11, 3.12 или 3.13.
Storops Python SDK 1.2.12.

Параметры

Параметр	Комментарии
auto_delete логическое значение	Указывает, может ли система автоматически удалять снимок. Допустимые значения: `false` `true`
day_interval целое число	Количество дней между созданием снимков. Применяется только, если тип правила — `every_n_days`.
day_of_month целое число	День месяца, для которого применяется правило расписания создания снимков. Применяется только, если тип правила — `every_month`. Значение должно находиться в диапазоне [1, 31].
days_of_week список / элементы=строка	Дни недели, для которых применяется правило расписания создания снимков. Применяется только, если тип правила — `every_week`. Допустимые значения: `"SUNDAY"` `"MONDAY"` `"TUESDAY"` `"WEDNESDAY"` `"THURSDAY"` `"FRIDAY"` `"SATURDAY"`
desired_retention целое число	Количество дней/часов, в течение которых будет храниться снимок. Если auto_delete имеет значение `true`, параметр desired_retention указывать нельзя. Максимальный поддерживаемый срок хранения — 31 день или 744 часа.
hour целое число	Час, в который будет создан снимок. Применяется для типов правил `every_n_days`, `every_week`, `every_month`. При создании, если параметр hour не указан, используется значение `0`. Значение должно находиться в диапазоне [0, 23].
hours_of_day список / элементы=целое число	Часы суток, в которые будет создаваться снимок. Применяется только, если тип правила — `every_day`.
id строка	Идентификатор расписания создания снимков.
interval целое число	Количество часов между созданием снимков. Применяется только, если тип правила — `every_n_hours`.
minute целое число	Смещение в минутах относительно начала часа, когда будет создан снимок. Применяется для всех типов правил. При создании, если параметр minute не указан, используется значение `0`. Значение должно находиться в диапазоне [0, 59].
name строка	Имя расписания создания снимков. При создании необходимо указать имя. Для любой операции укажите либо name, либо id (но не оба параметра).
password строка / обязательный	Пароль сервера управления Unity.
port целое число	Номер порта, через который осуществляется взаимодействие с сервером управления Unity. По умолчанию: `443`
retention_unit строка	Единица измерения срока хранения снимка. Допустимые значения: `"hours"` ← (по умолчанию) `"days"`
state строка / обязательный	Указывает, должно ли существовать расписание создания снимков. Допустимые значения: `"absent"` `"present"`
type строка	Тип правила, включаемого в расписание создания снимков. При создании или изменении необходимо указать тип. После создания расписания с определенным типом его можно изменить. Допустимые значения: `"every_n_hours"` `"every_day"` `"every_n_days"` `"every_week"` `"every_month"`
unispherehost строка / обязательный	IP-адрес или полное доменное имя сервера управления Unity.
username строка / обязательный	Имя пользователя сервера управления Unity.
validate_certs псевдонимы: verifycert логическое значение	Логическая переменная, указывающая, следует ли проверять сертификат SSL. `true` — указывает, что сертификат SSL необходимо проверять. `false` — указывает, что сертификат SSL проверять не нужно. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Расписание создания снимков, созданное с помощью Ansible, будет содержать только одно правило.
Изменение типа правила не допускается. Можно изменять другие параметры, не меняя тип.
Если существующее расписание создания снимков содержит более одного правила, разрешены только операции получения сведений и удаления.
Режим check_mode не поддерживается.
Модули этой коллекции с именем «dellemc.unity» предназначены для поддержки платформы хранения Dell Unity.

Примеры

- name: Create snapshot schedule (Rule Type - every_n_hours)
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_N_Hours_Testing"
      type: "every_n_hours"
      interval: 6
      desired_retention: 24
      state: "{{state_present}}"

- name: Create snapshot schedule (Rule Type - every_day)
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_Day_Testing"
      type: "every_day"
      hours_of_day:
          - 8
          - 14
      auto_delete: true
      state: "{{state_present}}"

- name: Create snapshot schedule (Rule Type - every_n_days)
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_N_Day_Testing"
      type: "every_n_days"
      day_interval: 2
      desired_retention: 16
      retention_unit: "days"
      state: "{{state_present}}"

- name: Create snapshot schedule (Rule Type - every_week)
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_Week_Testing"
      type: "every_week"
      days_of_week:
          - MONDAY
          - FRIDAY
      hour: 12
      minute: 30
      desired_retention: 200
      state: "{{state_present}}"

- name: Create snapshot schedule (Rule Type - every_month)
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_Month_Testing"
      type: "every_month"
      day_of_month: 17
      auto_delete: true
      state: "{{state_present}}"

- name: Get snapshot schedule details using name
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_N_Hours_Testing"
      state: "{{state_present}}"

- name: Get snapshot schedule details using id
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      id: "{{id}}"
      state: "{{state_present}}"

- name: Modify snapshot schedule details id
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      id: "{{id}}"
      type: "every_n_hours"
      interval: 8
      state: "{{state_present}}"

- name: Modify snapshot schedule using name
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_Day_Testing"
      type: "every_day"
      desired_retention: 200
      auto_delete: false
      state: "{{state_present}}"

- name: Delete snapshot schedule using id
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      id: "{{id}}"
      state: "{{state_absent}}"

- name: Delete snapshot schedule using name
  snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      name: "Ansible_Every_Day_Testing"
      state: "{{state_absent}}"

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

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

Ключ	Описание
changed логическое значение	Изменился ли ресурс. Возвращается: всегда Пример: `true`
snapshot_schedule_details словарь	Сведения о расписании создания снимков. Возвращается: если расписание создания снимков существует Пример: {"existed": true, "hash": 8742032390151, "id": "snapSch_63", "is_default": false, "is_modified": null, "is_sync_replicated": false, "luns": null, "modification_time": "2021-12-14 21:37:47.905000+00:00", "name": "SS7_empty_hour_SS", "rules": [{"access_type": "FilesystemSnapAccessTypeEnum.CHECKPOINT", "days_of_month": null, "days_of_week": {"DayOfWeekEnumList": []}, "existed": true, "hash": 8742032280772, "hours": [0], "id": "SchedRule_109", "interval": 2, "is_auto_delete": false, "minute": 0, "retention_time": 86400, "retention_time_in_hours": 24, "rule_type": "every_n_days", "type": "ScheduleTypeEnum.N_DAYS_AT_HHMM"}], "storage_resources": null, "version": "ScheduleVersionEnum.LEGACY"}
id строка	Системный идентификатор, присвоенный расписанию создания снимков. Возвращается: при успешном выполнении
luns словарь	Сведения о томах, для которых применяется расписание создания снимков. Возвращается: при успешном выполнении
UnityLunList список / элементы=строка	Список томов, для которых применяется расписание создания снимков. Возвращается: при успешном выполнении
UnityLun словарь	Сведения о томе. Возвращается: при успешном выполнении
id строка	Системный идентификатор, присвоенный тому. Возвращается: при успешном выполнении
name строка	Имя расписания создания снимков. Возвращается: при успешном выполнении
rules список / элементы=строка	Сведения о правилах, применяемых к расписанию создания снимков. Возвращается: при успешном выполнении
days_of_month список / элементы=строка	Дни месяца, для которых применяется правило расписания создания снимков. Возвращается: при успешном выполнении
days_of_week словарь	Дни недели, для которых применяется правило расписания создания снимков. Возвращается: при успешном выполнении
DayOfWeekEnumList список / элементы=строка	Перечисление дней недели. Возвращается: при успешном выполнении
hours список / элементы=строка	Периодичность создания снимков по часам для правила расписания. Возвращается: при успешном выполнении
id строка	Системный идентификатор правила. Возвращается: при успешном выполнении
interval целое число	Количество дней или часов между созданием снимков в зависимости от типа правила. Возвращается: при успешном выполнении
is_auto_delete логическое значение	Указывает, может ли система автоматически удалять снимок в соответствии с пороговыми значениями автоматического удаления в пуле. Возвращается: при успешном выполнении
minute целое число	Периодичность создания снимков в минутах для правила расписания. Возвращается: при успешном выполнении
retention_time целое число	Время в секундах, в течение которого следует хранить снимок. Возвращается: при успешном выполнении
retention_time_in_hours целое число	Время в часах, в течение которого следует хранить снимок. Возвращается: при успешном выполнении
rule_type строка	Тип правила, применяемого к расписанию создания снимков. Возвращается: при успешном выполнении
storage_resources словарь	Сведения о ресурсах хранения, для которых применяется расписание создания снимков. Возвращается: при успешном выполнении
UnityStorageResourceList список / элементы=строка	Список ресурсов хранения, для которых применяется расписание создания снимков. Возвращается: при успешном выполнении
UnityStorageResource словарь	Сведения о ресурсе хранения. Возвращается: при успешном выполнении
id строка	Системный идентификатор, присвоенный ресурсу хранения. Возвращается: при успешном выполнении

Авторы

Akash Shendge (@shenda1)

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

© 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/dellemc/unity/snapshotschedule_module.html