Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_aggregate — управление агрегатами NetApp ONTAP.

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_aggregate.

Добавлено в netapp.ontap 2.6.0

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

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

  • Создание, удаление агрегатов и управление ими в ONTAP.

Требования

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

  • Ansible 2.9 или новее — рекомендуется версия 2.12 или новее.
  • Python3 — рекомендуется версия 3.9 или новее.
  • netapp-lib требуется только при использовании ZAPI (устанавливается командой ‘pip install netapp-lib’). Обратите внимание, что netapp-lib устарела и больше не поддерживается. Используйте её на свой страх и риск.
  • Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии; для поддержки REST требуется ONTAP 9.6 или новее.

Параметры

Параметр

Комментарии

allow_flexgroups

логическое значение

добавлено в netapp.ontap 22.3.0

Этот необязательный параметр позволяет подключить хранилище объектов к агрегату, содержащему компоненты FlexGroup. Значение по умолчанию — false.

Не рекомендуется смешивать FabricPools и агрегаты без FabricPools в одной FlexGroup.

Все агрегаты, содержащие компоненты FlexGroup, следует подключить к хранилищу объектов.

Варианты:

  • false
  • true

cert_filepath

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу сертификата клиента SSL (.pem).

Не поддерживается в Python 2.6.

disk_class

строка

добавлено в netapp.ontap 21.16.0

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

Значение capacity_flash указано в Swagger, но ONTAP отклоняет его как недопустимое.

Варианты:

  • "capacity"
  • "performance"
  • "archive"
  • "solid_state"
  • "array"
  • "virtual"
  • "data_center"
  • "capacity_flash"

disk_count

целое число

Количество дисков, размещаемых в агрегате, включая диски четности.

Диски для нового агрегата выбираются из пула резервных дисков.

Сначала в агрегат включаются самые маленькие диски из этого пула, если не указан аргумент disk-size.

Необходимо указать либо disk-count, либо disks. Диапазон [0..2^31-1].

Обязательный параметр, когда state=present.

Изменить значение можно, только если указанное значение disk_count больше текущего.

При использовании типа RAID raid4 нельзя создать группу RAID из одного диска.

Если disk_count % raid_size == 1, будет добавлено только disk_count/raid_size * raid_size дисков.

Если disk_count равно 6, raid_type — raid4, а raid_size — 4, будут добавлены все 6 дисков.

Если disk_count равно 5, raid_type — raid4, а raid_size — 4, будет добавлено 5/4 * 4 = 4 диска. 1 диск добавлен не будет.

При использовании REST параметр nodes обязателен, если указан disk_count.

disk_size

целое число

добавлено в netapp.ontap 2.7.0

Размер диска для использования с размером блока 4 КБ. Будут использоваться диски, размер которых отличается от указанного не более чем на 10%.

При использовании REST значение преобразуется в байты с множителем 4096. Чтобы пропустить преобразование, используйте disk_size_with_unit.

disk_size_with_unit

строка

Размер диска в указанной единице измерения.

Положительное целое число, за которым следует единица измерения T/G/M/K. Например: 72G, 1T и 32M.

Единицу измерения можно не указывать — тогда значение задается в байтах (REST также принимает B).

Этот параметр игнорируется, если через параметр «disks» указан конкретный список дисков.

Необходимо использовать только один из параметров «disk-size» и «disk-size-with-unit».

При использовании REST значение преобразуется в байты, где K=1024.

disk_type

строка

добавлено в netapp.ontap 2.7.0

Тип диска, используемого для создания агрегата.

Не поддерживается в REST — см. disk_class.

SSD-NVM и SSD-CAP добавлены в ONTAP 9.6.

VMLUN добавлен в ONTAP 9.9.

Варианты:

  • "ATA"
  • "BSAS"
  • "FCAL"
  • "FSAS"
  • "LUN"
  • "MSATA"
  • "SAS"
  • "SSD"
  • "SSD-CAP"
  • "SSD-NVM"
  • "VMDISK"
  • "VMLUN"
  • "VMLUN-SSD"

disks

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

добавлено в netapp.ontap 2.8.0

Конкретный список дисков для нового агрегата.

Чтобы создать «зеркальный» агрегат из определенного списка дисков, необходимо указать параметры ‘disks’ и ‘mirror_disks’. Кроме того, в обоих списках должно быть одинаковое количество дисков.

Не поддерживается в REST.

encryption

логическое значение

добавлено в netapp.ontap 21.14.0

Включить ли программное шифрование.

При использовании CLI соответствует параметру -encrypt-with-aggr-key.

Требуется лицензия VE.

Варианты:

  • false
  • true

feature_flags

словарь

добавлено в netapp.ontap 20.5.0

Включить или отключить новую функцию.

Этот параметр можно использовать, чтобы включить экспериментальную функцию или отключить новую функцию, нарушающую обратную совместимость.

Поддерживаемые ключи и значения могут измениться без уведомления. Неизвестные ключи игнорируются.

force_ontap_version

строка

добавлено в netapp.ontap 21.23.0

Переопределить версию ONTAP кластера при использовании REST.

Если версия не соответствует целевому кластеру, поведение не определено.

Этот параметр предусмотрен как обходное решение на случай, если версию кластера невозможно прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

Значение должно иметь вид 9.10 или 9.10.1, где каждый элемент — целое число.

Если для use_rest задано значение auto, это может привести к переключению на ZAPI с учетом версии и возможностей платформы.

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

from_name

строка

добавлено в netapp.ontap 2.7.0

Имя агрегата, который нужно переименовать.

hostname

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

Имя хоста или IP-адрес экземпляра ONTAP.

http_port

целое число

Переопределить порт по умолчанию (80 или 443), указав этот порт.

https

логическое значение

Включить или отключить HTTPS.

Игнорируется при использовании REST, поскольку поддерживается только HTTPS.

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

Варианты:

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

ignore_pool_checks

логическое значение

добавлено в netapp.ontap 20.8.0

Допустимо только при использовании параметра disks.

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

Если задано значение true, эти проверки игнорируются.

Игнорируется при использовании REST, поскольку disks не поддерживается.

Варианты:

  • false
  • true

is_mirrored

логическое значение

добавлено в netapp.ontap 2.8.0

Указывает, что новый агрегат должен быть зеркальным (содержать два plex).

Если задано значение true, указанные диски будут распределены между двумя plex. По умолчанию новый агрегат не является зеркальным.

Этот параметр нельзя использовать, если конкретный список дисков задан в параметре ‘disks’ или ‘mirror_disks’.

Варианты:

  • false
  • true

key_filepath

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа клиента SSL.

lambda_config

словарь

добавлено в netapp.ontap 23.2.0

Параметры конфигурации функции прокси-сервера AWS Lambda.

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

aws_profile

строка

Имя профиля AWS, используемого для аутентификации.

aws_region

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

Название региона AWS.

function_name

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

Имя вызываемой функции AWS Lambda.

mirror_disks

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

добавлено в netapp.ontap 2.8.0

Список зеркальных дисков. Он должен содержать столько же дисков, сколько указано в ‘disks’.

Не поддерживается в REST.

name

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

Имя управляемого агрегата.

nodes

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

Узел или узлы, на которых будет создан агрегат. Если узел не указан, используется домашний узел управляющего LIF.

Только для ZAPI: если указано несколько узлов, будет создана полоса агрегатов (aggr stripe).

При использовании REST можно указать только один узел. Если задан disk_count, необходимо указать имя узла.

object_store_name

строка

добавлено в netapp.ontap 2.9.0

Имя конфигурации хранилища объектов, подключенного к агрегату.

ontapi

целое число

Версия API ONTAP, которую следует использовать.

password

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

строка

Пароль указанного пользователя.

raid_size

целое число

добавлено в netapp.ontap 2.7.0

Задает максимальное количество дисков в группе RAID.

raid_type

строка

добавлено в netapp.ontap 2.7.0

Задает тип групп RAID для нового агрегата.

raid_0 доступен только в ONTAP Select.

Варианты:

  • "raid4"
  • "raid_dp"
  • "raid_tec"
  • "raid_0"

service_state

строка

Определяет, должен ли указанный агрегат быть включен или отключен. Если агрегат не существует, он создается.

Поддерживается в REST начиная с версии 9.11.1.

Варианты:

  • "online"
  • "offline"

snaplock_type

строка

добавлено в netapp.ontap 20.1.0

Тип SnapLock для создаваемого агрегата.

Варианты:

  • "compliance"
  • "enterprise"
  • "non_snaplock"

spare_pool

строка

добавлено в netapp.ontap 2.8.0

Задает пул резервных дисков, из которого выбираются диски для создания нового агрегата.

Не поддерживается в REST.

Варианты:

  • "Pool0"
  • "Pool1"

state

строка

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

Варианты:

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

tags

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

добавлено в netapp.ontap 22.6.0

Теги — необязательный способ отслеживать использование ресурса.

Значения тегов должны иметь формат ключ:значение, например [“team:csi”, “environment:test”]

time_out

целое число

добавлено в netapp.ontap 2.8.0

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

По умолчанию задано 100 секунд.

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

unmount_volumes

логическое значение

Если задано значение “true”, все тома, размещенные в указанном агрегате, будут отключены перед выполнением операции перевода агрегата в автономный режим.

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

Не поддерживается в REST: по умолчанию REST отключает тома при попытке перевести агрегат в автономный режим.

Варианты:

  • false
  • true

use_lambda

логическое значение

добавлено в netapp.ontap 23.2.0

Определяет, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP.

Поддерживается только при использовании REST.

Варианты:

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

use_rest

строка

Определяет, использовать REST или ZAPI.

always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка.

never — всегда использовать ZAPI, если модуль его поддерживает. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка.

auto — пытаться использовать REST API, если модуль и его параметры поддерживают REST. В противном случае использовать ZAPI.

По умолчанию: "always"

username

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

строка

Это может быть учетная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM.

Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

Поддерживаются два метода аутентификации:

  1. Базовая аутентификация с использованием имени пользователя и пароля.
  2. Аутентификация по сертификату SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа.

Для использования сертификата его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату.

validate_certs

логическое значение

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

Задавать значение False следует только на контролируемых вами ресурсах, использующих самоподписанные сертификаты.

Варианты:

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

wait_for_online

логическое значение

добавлено в netapp.ontap 2.8.0

Задайте для этого параметра значение ‘true’ для синхронного выполнения при создании (ожидание перехода агрегата в состояние online).

Задайте для этого параметра значение ‘false’ для асинхронного выполнения.

При асинхронном выполнении процесс завершается сразу после отправки запроса, не проверяя состояние агрегата.

Игнорируется при использовании REST (ожидание выполняется всегда).

Варианты:

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

Примечания

Примечание

  • Поддерживается check_mode.
  • Поддерживаются ZAPI и REST.
  • При использовании REST поддерживается функция прокси-сервера AWS Lambda. Пример использования см. в README.
  • Модули с префиксом na_ontap предназначены для работы с платформой хранения ONTAP.
  • HTTPS включен по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create Aggregates and wait 5 minutes until aggregate is online in ZAPI.
  netapp.ontap.na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    disk_count: 10
    wait_for_online: true
    time_out: 300
    snaplock_type: non_snaplock
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create Aggregates in REST.
  netapp.ontap.na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    disk_count: 10
    nodes: ontap-node
    snaplock_type: non_snaplock
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Manage Aggregates in ZAPI, modify service state.
  netapp.ontap.na_ontap_aggregate:
    state: present
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    disk_count: 10
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Manage Aggregates in REST, increase disk count.
  netapp.ontap.na_ontap_aggregate:
    state: present
    name: ansibleAggr
    disk_count: 20
    nodes: ontap-node
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Attach object store
  netapp.ontap.na_ontap_aggregate:
    state: present
    name: aggr4
    object_store_name: sgws_305
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Rename Aggregates
  netapp.ontap.na_ontap_aggregate:
    state: present
    service_state: online
    from_name: ansibleAggr
    name: ansibleAggr2
    disk_count: 20
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete Aggregates
  netapp.ontap.na_ontap_aggregate:
    state: absent
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

  • NetApp Ansible Team (@carchi8py)

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

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

© 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/netapp/ontap/na_ontap_aggregate_module.html

Spec-Zone.ru

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