Spec-Zone.ru › Ansible

dellemc.powerflex.snapshot_policy модуль — Управление политиками снимков на Dell PowerFlex

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.powerflex. Для использования этого модуля потребуются дополнительные требования. Смотрите Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: dellemc.powerflex.snapshot_policy.

Добавлен в dellemc.powerflex 1.7.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

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

  • Система хранения Dell PowerFlex версии 3.6 или более поздней.
  • PyPowerFlex 1.12.0.

Параметры

Параметр

Комментарии

access_mode

строка

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

Варианты:

  • "READ_WRITE"
  • "READ_ONLY"

auto_snapshot_creation_cadence

словарь

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

time

целое число

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

unit

строка

Единица измерения интервала создания моментальных снимков по расписанию.

Варианты:

  • "Minute" ← (по умолчанию)
  • "Hour"
  • "Day"
  • "Week"

hostname

псевдонимы: gateway_host

строка / обязательный

IP-адрес или FQDN хоста PowerFlex.

new_name

строка

Новое имя политики создания моментальных снимков.

num_of_retained_snapshots_per_level

список / элементы=целое число

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

password

строка / обязательный

Пароль хоста PowerFlex.

pause

булево

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

Варианты:

  • false
  • true

port

целое число

Номер порта, через который происходит взаимодействие с хостом PowerFlex.

По умолчанию: 443

secure_snapshots

булево

Защищать моментальные снимки или нет.

Используется только в операции создания.

Варианты:

  • false
  • true

snapshot_policy_id

строка

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

Кроме операции создания, все остальные операции можно выполнить, используя snapshot_policy_id.

Взаимоисключающее с snapshot_policy_name.

snapshot_policy_name

строка

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

Уникально в массиве PowerFlex.

Взаимоисключающее с snapshot_policy_id.

source_volume

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

Детали исходного тома для добавления или удаления.

auto_snap_removal_action

строка

Способы обработки моментальных снимков, созданных политикой (автоматические снимки).

Должно быть указано, когда state установлено в 'absent'.

Варианты:

  • "Remove"
  • "Detach"

detach_locked_auto_snapshots

булево

Отсоединять заблокированные автоматические снимки при удалении исходного тома.

Варианты:

  • false
  • true

id

строка

Уникальный идентификатор исходного тома для добавления или удаления.

Взаимоисключающее с name.

name

строка

Имя исходного тома для добавления или удаления.

Взаимоисключающее с id.

state

строка

Состояние исходного тома.

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

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

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

state

строка

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

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
END_OF_DOCUMENT_MARKER

timeout

integer

Время, после которого произойдёт разрыв соединения.

Указывается в секундах.

По умолчанию: 120

username

string / обязательно

Имя пользователя хоста PowerFlex.

validate_certs

псевдонимы: verifycert

boolean

Булево значение, указывающее, нужно ли проверять сертификат SSL.

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

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

Варианты:

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

Примечания

Примечание

  • Поддерживается режим проверки.
  • Модули, присутствующие в коллекции с именем «dellemc.powerflex», разработаны для поддержки платформы хранения Dell PowerFlex.

Примеры

- name: Create a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    access_mode: "READ_WRITE"
    secure_snapshots: false
    auto_snapshot_creation_cadence:
      time: 1
      unit: "Hour"
    num_of_retained_snapshots_per_level:
      - 20
    state: "present"

- name: Get snapshot policy details using name
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"

- name: Get snapshot policy details using id
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_id: "snapshot_policy_id_1"

- name: Modify a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    auto_snapshot_creation_cadence:
      time: 2
      unit: "Hour"
    num_of_retained_snapshots_per_level:
      - 40

- name: Rename a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    new_name: "snapshot_policy_name_1_new"

- name: Add source volume
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name_1"
    source_volume:
      - name: "source_volume_name_1"
      - id: "source_volume_id_2"
        state: "present"

- name: Remove source volume
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    source_volume:
      - name: "source_volume_name_1"
        auto_snap_removal_action: 'Remove'
        state: "absent"
      - id: "source_volume_id_2"
        auto_snap_removal_action: 'Remove'
        detach_locked_auto_snapshots: true
        state: "absent"

- name: Pause a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    pause: true

- name: Resume a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "{{snapshot_policy_name}}"
    pause: false

- name: Delete a snapshot policy
  dellemc.powerflex.snapshot_policy:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_policy_name: "snapshot_policy_name"
    state: "absent"

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

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

Ключ

Описание

changed

boolean

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

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

Пример: false

snapshot_policy_details

dictionary

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

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

Пример: {"autoSnapshotCreationCadenceInMin": 120, "id": "15ae842800000004", "lastAutoSnapshotCreationFailureReason": "NR", "lastAutoSnapshotFailureInFirstLevel": false, "links": [{"href": "/api/instances/SnapshotPolicy::15ae842800000004", "rel": "self"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/Statistics", "rel": "/api/SnapshotPolicy/relationship/Statistics"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/SourceVolume", "rel": "/api/SnapshotPolicy/relationship/SourceVolume"}, {"href": "/api/instances/SnapshotPolicy::15ae842800000004/relationships/AutoSnapshotVolume", "rel": "/api/SnapshotPolicy/relationship/AutoSnapshotVolume"}, {"href": "/api/instances/System::0e7a082862fedf0f", "rel": "/api/parent/relationship/systemId"}], "maxVTreeAutoSnapshots": 40, "name": "Sample_snapshot_policy_1", "nextAutoSnapshotCreationTime": 1683709201, "numOfAutoSnapshots": 0, "numOfCreationFailures": 0, "numOfExpiredButLockedSnapshots": 0, "numOfLockedSnapshots": 0, "numOfRetainedSnapshotsPerLevel": [40], "numOfSourceVolumes": 0, "secureSnapshots": false, "snapshotAccessMode": "ReadWrite", "snapshotPolicyState": "Active", "statistics": {"autoSnapshotVolIds": [], "expiredButLockedSnapshotsIds": [], "numOfAutoSnapshots": 0, "numOfExpiredButLockedSnapshots": 0, "numOfSrcVols": 0, "srcVolIds": []}, "systemId": "0e7a082862fedf0f", "timeOfLastAutoSnapshot": 0, "timeOfLastAutoSnapshotCreationFailure": 0}

autoSnapshotCreationCadenceInMin

integer

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

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

id

string

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

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

lastAutoSnapshotCreationFailureReason

string

Причина сбоя последнего автоматического создания моментального снимка.

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

lastAutoSnapshotFailureInFirstLevel

boolean

Сбой последнего автоматического моментального снимка на первом уровне.

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

maxVTreeAutoSnapshots

integer

Максимальное количество автоматических моментальных снимков VTree.

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

name

string

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

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

nextAutoSnapshotCreationTime

integer

Время создания следующего автоматического моментального снимка.

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

numOfAutoSnapshots

integer

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

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

numOfCreationFailures

integer

Количество сбоев при создании.

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

numOfExpiredButLockedSnapshots

integer

Количество просроченных, но заблокированных моментальных снимков.

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

numOfLockedSnapshots

integer

Количество заблокированных моментальных снимков.

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

numOfRetainedSnapshotsPerLevel

list / elements=string

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

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

numOfSourceVolumes

integer

Количество исходных томов.

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

secureSnapshots

boolean

Защищены ли моментальные снимки.

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

snapshotAccessMode

string

Режим доступа к моментальным снимкам.

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

snapshotPolicyState

string

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

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

statistics

dictionary

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

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

autoSnapshotVolIds

list / elements=string

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

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

expiredButLockedSnapshotsIds

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

Идентификаторы истекших, но заблокированных снимков.

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

numOfAutoSnapshots

целое число

Количество автоматических снимков.

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

numOfExpiredButLockedSnapshots

целое число

Количество истекших, но заблокированных снимков.

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

numOfSrcVols

целое число

Количество исходных томов.

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

srcVolIds

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

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

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

systemId

строка

Уникальный идентификатор системы PowerFlex.

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

timeOfLastAutoSnapshot

строка

Время создания последнего автоматического снимка.

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

timeOfLastAutoSnapshotCreationFailure

строка

Время последней неудачи при создании автоматического снимка.

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

Авторы

  • Trisha Datta (@trisha-dell)

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

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

© 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/powerflex/snapshot_policy_module.html

Spec-Zone.ru

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