Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_security_key_manager — диспетчер ключей безопасности NetApp ONTAP.

Примечание

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

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

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

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

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

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

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

  • Добавление, удаление или настройка управления ключами в NetApp ONTAP.
  • При использовании ZAPI этот модуль ограничен добавлением или удалением внешних серверов ключей. Сертификатами он не управляет.
  • При использовании REST модуль может создать внешний диспетчер ключей; для его создания необходимы сертификаты.
  • При использовании REST поддерживается встроенный диспетчер ключей.

Требования

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

  • Ansible 2.9 или более поздней версии — рекомендуется версия 2.12 или более поздняя.
  • Python 3 — рекомендуется версия 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.

external

dictionary

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

Настраивает внешний диспетчер ключей.

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

Взаимоисключающий параметр с ip_address и onboard.

client_certificate

string

Имя сертификата клиента (уже установленного в кластере или SVM).

Обязателен при создании внешнего диспетчера ключей.

server_ca_certificates

list / elements=string

Список имён сертификатов ЦС сервера (уже установленных в кластере или SVM).

Обязателен при создании внешнего диспетчера ключей.

servers

list / elements=string

Список внешних серверов ключей для управления ключами.

Формат — ip_address:port или FQDN:port. Если порт не указан, по умолчанию используется значение tcp_port.

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

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, где каждый компонент — целое число.

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

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

hostname

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

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

http_port

integer

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

https

boolean

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

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

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

Варианты:

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

ip_address

string

IP-адрес внешнего сервера управления ключами.

Взаимоисключающий параметр с external и onboard.

Обязателен при использовании ZAPI.

key_filepath

string

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

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

node

string

Узел, на котором работает сервер управления ключами.

Игнорируется; при наличии параметра выдается предупреждение.

Устарел начиная с версии 21.22.0, так как никогда не использовался.

onboard

dictionary

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

Настраивает встроенное управление ключами.

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

Взаимоисключающий параметр с ip_address и external.

from_passphrase

string

Общая для кластера парольная фраза.

Игнорируется, если встроенный диспетчер ключей ещё не существует.

Обязателен для изменения парольной фразы.

passphrase

string

Общая для кластера парольная фраза.

synchronize

boolean

Синхронизирует отсутствующие встроенные ключи на любом узле кластера.

Варианты:

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

ontapi

integer

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

password

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

string

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

state

string

Должен ли указанный диспетчер ключей существовать.

Варианты:

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

tcp_port

integer

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

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

use_lambda

boolean

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

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

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

Варианты:

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

use_rest

string

Использовать REST или ZAPI.

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

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

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

По умолчанию: "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 ← (по умолчанию)

vserver

string

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

Имя SVM при использовании внешнего диспетчера ключей.

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

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

Примечания

Примечание

  • Хотя node допускается в качестве параметра, в модуле он не используется.
  • Поддерживается check_mode.
  • Поддерживается только на уровне кластера при использовании ZAPI или для встроенного диспетчера ключей.
  • Поддержка ZAPI основана на устаревших API начиная с ONTAP 9.6.
  • Модули с префиксом na_ontap разработаны для поддержки платформы хранения ONTAP.
  • HTTPS включен по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»

Примеры

# Assuming module_defaults are used to set up hostname, username, password, https, validate_certs
- name: Delete Key Manager
  netapp.ontap.na_ontap_security_key_manager:
    state: absent

- name: Add Key Manager - ZAPI
  netapp.ontap.na_ontap_security_key_manager:
    ip_address: 0.0.0.0

- name: Add/Modify external Key Manager - REST
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    external:
      servers: 10.10.10.10:5696
      client_certificate: kmip_client
      server_ca_certificates: kmip_ca
    vserver: "{{ vserver | default(omit) }}"

- name: Add/Modify external Key Manager - REST
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    external:
      servers: 10.10.10.10:5696,10.10.10.10:5697,10.10.10.11:5696
      client_certificate: kmip_client
      server_ca_certificates: kmip_ca
    vserver: "{{ vserver | default(omit) }}"

- name: Add onboard Key Manager
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    onboard:
      passphrase: "hello, le soleil brille, brille, brille!"

- name: Change passphrase for onboard Key Manager
  netapp.ontap.na_ontap_security_key_manager:
    state: present
    onboard:
      from_passphrase: "hello, le soleil brille, brille, brille!"
      passphrase: "hello, le soleil brille, brille, brille! - 2"
      synchronize: true

Авторы

  • Команда 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_security_key_manager_module.html

Spec-Zone.ru

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