Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_cg — модуль NetApp ONTAP для управления операциями, связанными с группами согласованности.

Примечание

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

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

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

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

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

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

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

  • Создание группы согласованности с одной или несколькими группами согласованности, содержащими новые или существующие тома.
  • Изменение или удаление существующей группы согласованности.

Требования

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

  • 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 или более поздняя версия.

Параметры

Параметр

Комментарии

cert_filepath

string

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

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

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

consistency_groups

list / elements=dictionary

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

luns

list / elements=dictionary

Массив LUN можно использовать для создания или изменения LUN в группе согласованности на новом или существующем томе, входящем в группу согласованности.

lun_maps

list / elements=dictionary

Массив сопоставлений LUN.

igroup_initiators

list / elements=string

Список инициаторов, входящих в группу.

igroup_name

string

Имя группы инициаторов.

os_type

string

Тип ОС для групп инициаторов.

name

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

Полное имя пути LUN, состоящее из префикса «/vol», имени тома, имени qtree (необязательно) и базового имени LUN.

Например: /vol/volume1/lun1 или /vol/volume1/qtree1/lun1.

os_type

string

Тип ОС для LUN.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр «count»: имя считается префиксом, а суффикс вида _<N> генерируется, где N — следующий доступный числовой индекс, начиная с 1.

action

string

Выполняемая операция.

Варианты:

  • "create"

count

integer

Количество элементов, для которых выполняется операция.

size

integer

Указывает выделенный размер в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

name

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

Указывает имя группы согласованности.

namespaces

list / elements=dictionary

Массив пространств имён можно использовать для создания или изменения пространств имён в группе согласованности.

name

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

Имя пространства имён NVMe в формате «/vol/<volume>[/<qtree>]/<namespace>», где имя qtree указывать необязательно.

Например: /vol/volume1/namespace1 или /vol/volume1/qtree1/namespace1.

os_type

string

Тип ОС для пространства имён.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр «count»: имя считается префиксом, а суффикс вида _<N> генерируется, где N — следующий доступный числовой индекс, начиная с 1.

action

string

Выполняемая операция.

Варианты:

  • "create"

count

integer

Количество элементов, для которых выполняется операция.

size

integer

Указывает выделенный размер в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

provisioning_options

dictionary

Параметры, применяемые к операции.

action

string

Выполняемая операция.

Варианты:

  • "create"
  • "add"
  • "remove"

name

string

Новое имя группы согласованности. Требуется для разрешения конфликтов имён.

Требуется ONTAP 9.13.1 или более поздней версии.

qos_policy

string

Указывает политику QoS для группы согласованности.

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

snapshot_policy

string

Указывает политику Snapshot для группы согласованности.

volumes

list / elements=dictionary

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

Массив томов можно использовать для создания новых томов в группе согласованности или добавления в неё существующих томов.

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

name

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

Указывает имя тома.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр «count»: имя считается префиксом, а суффикс вида _<N> генерируется, где N — следующий доступный числовой индекс, начиная с 1.

action

string

Операция, выполняемая над томом.

Варианты:

  • "create"
  • "add"
  • "remove"

count

integer

Количество элементов, для которых выполняется операция.

qos_policy

string

Политика QoS для этого тома.

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

size

integer

Указывает выделенный размер тома в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

snapshot_policy

string

Политика Snapshot для этого тома.

feature_flags

dictionary

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

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

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

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

force_ontap_version

string

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

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

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

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

Значение должно иметь формат 9.10 или 9.10.1; каждый элемент должен быть целым числом.

hostname

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

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

http_port

integer

Переопределяет порт по умолчанию (80 или 443).

https

boolean

Включение и отключение HTTPS.

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

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

Варианты:

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

key_filepath

string

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

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

luns

list / elements=dictionary

Массив LUN можно использовать для создания или изменения LUN в группе согласованности на новом или существующем томе, входящем в группу согласованности.

lun_maps

list / elements=dictionary

Массив сопоставлений LUN.

igroup_initiators

list / elements=string

Список инициаторов, входящих в группу.

igroup_name

string

Имя группы инициаторов.

os_type

string

Тип ОС для групп инициаторов.

name

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

Полное имя пути LUN, состоящее из префикса «/vol», имени тома, имени qtree (необязательно) и базового имени LUN.

Например: /vol/volume1/lun1 или /vol/volume1/qtree1/lun1.

os_type

string

Тип ОС для LUN.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр «count»: имя считается префиксом, а суффикс вида _<N> генерируется, где N — следующий доступный числовой индекс, начиная с 1.

action

string

Выполняемая операция.

Варианты:

  • "create"

count

integer

Количество элементов, для которых выполняется операция.

size

integer

Указывает выделенный размер в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

name

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

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

namespaces

list / elements=dictionary

Массив пространств имён можно использовать для создания или изменения пространств имён в группе согласованности.

name

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

Имя пространства имён NVMe в формате «/vol/<volume>[/<qtree>]/<namespace>», где имя qtree указывать необязательно.

Например: /vol/volume1/namespace1 или /vol/volume1/qtree1/namespace1.

os_type

string

Тип ОС для пространства имен.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр ‘count’, поскольку имя считается префиксом и генерируется суффикс вида _<N>, где N — следующий доступный числовой индекс, начиная с 1.

action

string

Выполняемая операция.

Варианты:

  • "create"

count

integer

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

size

integer

Задает выделенный размер в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

password

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

string

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

qos_policy

string

Задает политику QoS для группы согласованности.

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

snapshot_policy

string

Задает политику Snapshot для группы согласованности.

state

string

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

Варианты:

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

use_lambda

boolean

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

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

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

Варианты:

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

use_rest

string

Этот модуль поддерживает только REST.

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

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

username

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

string

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

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

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

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

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

validate_certs

boolean

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

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

Варианты:

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

volumes

list / elements=dictionary

Список томов, включаемых в группу согласованности.

Массив volumes можно использовать для создания новых томов в группе согласованности и добавления в нее существующих томов.

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

Удаление всех томов из группы согласованности приведет к автоматическому удалению группы.

name

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

Задает имя тома.

provisioning_options

dictionary

Параметры, применяемые к операции.

Модуль не является идемпотентным, если задан параметр ‘count’, поскольку имя считается префиксом и генерируется суффикс вида _<N>, где N — следующий доступный числовой индекс, начиная с 1.

action

string

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

Варианты:

  • "create"
  • "add"
  • "remove"

count

integer

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

qos_policy

string

Политика QoS для этого тома.

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

size

integer

Задает выделенный размер тома в size_unit.

size_unit

string

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

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb"
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

snapshot_policy

string

Политика Snapshot для этого тома.

vserver

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

Задает SVM, в которой находится группа согласованности.

Примечания

Примечание

  • Поддерживается только с REST и требует ONTAP 9.10.1 или более поздней версии.
  • Операция обновления никогда не удаляет элементы хранилища. Сопоставление группы согласованности с igroup или подсистемами, а также отмена такого сопоставления не поддерживаются.
  • Операция удаления не удаляет связанные тома или LUN. Для удаления этих элементов используйте соответствующие модули связанных объектов.
  • Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
  • По умолчанию включен протокол https, его использование рекомендуется. Чтобы включить http в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Creating a single consistency group with a new SAN volume
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: test_cg1
    volumes:
      - name: test_vol1
        size: 50
        size_unit: mb
        provisioning_options:
          action: create
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Adding an existing volume to an existing consistency group
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: test_cg1
    volumes:
      - name: test_vol2
        provisioning_options:
          action: add
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Adding LUNs to an existing volume in an existing consistency group
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: test_cg1
    luns:
      - name: "/vol/test_vol2/new_lun"
        size: 5
        size_unit: mb
        os_type: linux
        provisioning_options:
          action: create
        lun_maps:
          - igroup_name: new_igroup1
            igroup_initiators:
              - iqn.1995-08.com.example:new-initiator1
            os_type: linux
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Adding namespaces to an existing volume in an existing consistency group
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: test_cg1
    namespaces:
      - name: "/vol/test_vol2/new_namespace"
        size: 5
        size_unit: mb
        os_type: linux
        provisioning_options:
          action: create
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Deleting a CG (consistency group)
  netapp.ontap.na_ontap_cg:
    state: absent
    vserver: svm1
    name: test_cg1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Creating a parent CG with two child consistency groups with existing SAN volumes
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: parent_cg
    consistency_groups:
      - name: child_1
        volumes:
          - name: test_vol1
            provisioning_options:
              action: add
      - name: child_2
        volumes:
          - name: test_vol2
            provisioning_options:
              action: add
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Removing a child consistency group from nested CG
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: parent_cg
    consistency_groups:
      - name: child_2
        provisioning_options:
          action: remove
          name: new_single_cg
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Creating a parent CG with a new child CG with existing volumes
  netapp.ontap.na_ontap_cg:
    state: present
    vserver: svm1
    name: parent_cg
    consistency_groups:
      - name: child_1
        provisioning_options:
          action: create
        volumes:
          - name: test_vol1
            provisioning_options:
              action: add
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

Авторы

  • Команда NetApp Ansible (@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_cg_module.html

Spec-Zone.ru

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