Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию dellemc.powerflex (версия 3.0.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 2.0.0.

Параметры

Параметр

Комментарии

access_mode

string

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

Режим доступа READ_ONLY поддерживается только начиная с PowerFlex 5.0.

Варианты:

  • "READ_WRITE"
  • "READ_ONLY"

auto_snapshot_creation_cadence

dictionary

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

time

integer

Интервал между созданием двух снимков.

unit

string

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

Варианты:

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

hostname

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

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

IP-адрес или полное доменное имя узла PowerFlex.

new_name

string

Новое имя политики снимков.

num_of_retained_snapshots_per_level

list / элементы типа integer

Количество сохраняемых снимков для каждого уровня.

password

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

Пароль узла PowerFlex.

pause

boolean

Приостановить или возобновить политику снимков.

Варианты:

  • false
  • true

port

integer

Номер порта, используемого для связи с узлом PowerFlex.

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

secure_snapshots

boolean

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

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

Варианты:

  • false
  • true

snapshot_policy_id

string

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

Все операции, кроме создания, можно выполнять с помощью параметра snapshot_policy_id.

Не может использоваться одновременно с snapshot_policy_name.

snapshot_policy_name

string

Имя политики снимков.

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

Не может использоваться одновременно с snapshot_policy_id.

source_volume

list / элементы типа dictionary

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

auto_snap_removal_action

string

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

Необходимо указать, если для параметра state задано значение 'absent'.

Варианты:

  • "Remove"
  • "Detach"

detach_locked_auto_snapshots

boolean

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

Варианты:

  • false
  • true

id

string

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

Не может использоваться одновременно с name.

name

string

Имя исходного тома, который нужно добавить или удалить.

Не может использоваться одновременно с id.

state

string

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

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

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

Варианты:

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

state

string

Состояние политики снимков.

Варианты:

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

timeout

integer

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

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

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

username

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

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

validate_certs

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

boolean

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

true — указывает, что сертификат SSL необходимо проверить.

false — указывает, что сертификат SSL проверять не следует.

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Выполняет задачу для проверки, не выполняя действий на целевом компьютере.

diff_mode

Поддержка: полная

Выполняет задачу, чтобы сообщить о внесенных или планируемых изменениях.

Примечания

Примечание

  • Статистика объявлена устаревшей начиная с PowerFlex 5.0.
  • Режим доступа READ_ONLY поддерживается только начиная с PowerFlex 5.0.
  • Модули коллекции с именем ‘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

Статистические данные о политике создания снимков. Устарело начиная с PowerFlex 5.0.

Возвращается: при успешном выполнении

autoSnapshotVolIds

list / elements=string

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

Возвращается: при успешном выполнении

expiredButLockedSnapshotsIds

list / elements=string

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

Возвращается: при успешном выполнении

numOfAutoSnapshots

integer

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

Возвращается: при успешном выполнении

numOfExpiredButLockedSnapshots

integer

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

Возвращается: при успешном выполнении

numOfSrcVols

integer

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

Возвращается: при успешном выполнении

srcVolIds

list / elements=string

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

Возвращается: при успешном выполнении

systemId

string

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

Возвращается: при успешном выполнении

timeOfLastAutoSnapshot

string

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

Возвращается: при успешном выполнении

timeOfLastAutoSnapshotCreationFailure

string

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

Возвращается: при успешном выполнении

Авторы

  • Trisha Datta (@trisha-dell)

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

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

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

Spec-Zone.ru

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