Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции dellemc.unity (версия 2.0.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.1 или более поздней.
  • Ansible-core 2.14 или более поздней версии.
  • Python 3.9, 3.10 или 3.11.
  • Storops Python SDK 1.2.11.

Параметры

Параметр

Комментарии

auto_delete

boolean

Указывает, может ли система автоматически удалять моментальный снимок.

Варианты:

  • false
  • true

day_interval

integer

Количество дней между моментальными снимками.

Применимо только когда тип правила every_n_days.

day_of_month

integer

День месяца, для которого применяется правило расписания моментальных снимков.

Применимо только когда тип правила every_month.

Значение должно быть [1, 31].

days_of_week

list / elements=string

Дни недели, для которых применяется правило расписания моментальных снимков.

Применимо только когда тип правила every_week.

Варианты:

  • "SUNDAY"
  • "MONDAY"
  • "TUESDAY"
  • "WEDNESDAY"
  • "THURSDAY"
  • "FRIDAY"
  • "SATURDAY"

desired_retention

integer

Количество дней/часов, в течение которых будет храниться моментальный снимок.

Когда auto_delete true, desired_retention не может быть указан.

Максимальный срок хранения составляет 31 день или 744 часа.

hour

integer

Час, когда будет сделан моментальный снимок.

Применимо для типов правил every_n_days, every_week, every_month.

Для операции создания, если параметр hour не указан, значение будет принято как 0.

Значение должно быть [0, 23].

hours_of_day

list / elements=integer

Часы дня, когда будет сделан моментальный снимок.

Применимо только когда тип правила every_day.

id

string

Идентификатор расписания моментальных снимков.

interval

integer

Количество часов между моментальными снимками.

Применимо только когда тип правила every_n_hours.

minute

integer

Смещение в минутах от часа, когда будет сделан моментальный снимок.

Применимо для всех типов правил.

Для операции создания, если параметр minute не указан, значение будет принято как 0.

Значение должно быть [0, 59].

name

string

Имя расписания моментальных снимков.

Имя обязательно для операции создания.

Укажите либо name, либо id (но не оба) для любой операции.

password

string / required

Пароль сервера управления Unity.

port

integer

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

Значение по умолчанию: 443

retention_unit

string

Единица измерения срока хранения моментального снимка.

Варианты:

  • "hours" ← (по умолчанию)
  • "days"

state

string / required

Определяет, должно ли существовать расписание моментальных снимков или нет.

Варианты:

  • "absent"
  • "present"

type

string

Тип правила, которое должно быть включено в расписание моментальных снимков.

Тип обязателен для любой операции создания или изменения.

После того, как расписание моментальных снимков создано с одним типом, его можно изменить.

Варианты:

  • "every_n_hours"
  • "every_day"
  • "every_n_days"
  • "every_week"
  • "every_month"

unispherehost

string / required

IP-адрес или FQDN сервера управления Unity.

username

string / required

Имя пользователя сервера управления Unity.

validate_certs

aliases: verifycert

boolean

Логическая переменная, указывающая, следует ли проверять SSL-сертификат или нет.

true - Указывает, что SSL-сертификат должен быть проверен.

false - Указывает, что SSL-сертификат не должен быть проверен.

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Create snapshot schedule (Rule Type - every_n_hours)
  dellemc.unity.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)
  dellemc.unity.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)
  dellemc.unity.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)
  dellemc.unity.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)
  dellemc.unity.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
  dellemc.unity.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
  dellemc.unity.snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      id: "{{id}}"
      state: "{{state_present}}"

- name: Modify snapshot schedule details id
  dellemc.unity.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
  dellemc.unity.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
  dellemc.unity.snapshotschedule:
      unispherehost: "{{unispherehost}}"
      validate_certs: "{{validate_certs}}"
      username: "{{username}}"
      password: "{{password}}"
      id: "{{id}}"
      state: "{{state_absent}}"

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

Значения возврата

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

Key

Description

changed

boolean

Изменился ли ресурс или нет.

Возвращено: всегда

Пример: true

snapshot_schedule_details

dictionary

Подробная информация о расписании снимков.

Возвращено: Когда существует расписание снимков

Пример: {"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

string

Идентификатор системы, присвоенный расписанию снимков.

Возвращено: успех

luns

dictionary

Подробная информация о томах, к которым применяется расписание снимков.

Возвращено: успех

UnityLunList

list / elements=string

Список томов, к которым применяется расписание снимков.

Возвращено: успех

UnityLun

dictionary

Подробная информация о томе.

Возвращено: успех

id

string

Идентификатор системы, присвоенный тому.

Возвращено: успех

name

string

Название расписания снимков.

Возвращено: успех

rules

list / elements=string

Подробная информация о правилах, применяемых к расписанию снимков.

Возвращено: успех

days_of_month

list / elements=string

Дни месяца, к которым применяется правило расписания снимков.

Возвращено: успех

days_of_week

dictionary

Дни недели, к которым применяется правило расписания снимков.

Возвращено: успех

DayOfWeekEnumList

list / elements=string

Перечисление дней недели.

Возвращено: успех

hours

list / elements=string

Частотность по часам для правила расписания снимков.

Возвращено: успех

id

string

Идентификатор системы правила.

Возвращено: успех

interval

integer

Количество дней или часов между снимками, в зависимости от типа правила.

Возвращено: успех

is_auto_delete

boolean

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

Возвращено: успех

minute

integer

Минутная частота для правила расписания снимков.

Возвращено: успех

retention_time

integer

Период времени в секундах, в течение которого необходимо хранить снимок.

Возвращено: успех

retention_time_in_hours

integer

Период времени в часах, в течение которого необходимо хранить снимок.

Возвращено: успех

rule_type

string

Тип правила, применяемого к расписанию снимков.

Возвращено: успех

storage_resources

словарь

Подробная информация о ресурсах хранения, к которым применено расписание создания моментальных снимков.

Возвращается при: успехе

UnityStorageResourceList

список / элементы=строка

Список ресурсов хранения, к которым применено расписание создания моментальных снимков.

Возвращается при: успехе

UnityStorageResource

словарь

Подробная информация о ресурсе хранения.

Возвращается при: успехе

id

строка

Идентификатор ресурса хранения, присвоенный системой.

Возвращается при: успехе

Авторы

  • Akash Shendge (@shenda1)

Ссылки на сборку

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/unity/snapshotschedule_module.html

Spec-Zone.ru

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