модуль netapp.ontap.na_ontap_publickey — настройка открытого ключа NetApp ONTAP

Примечание

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

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

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

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

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

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

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

Добавляет, изменяет или удаляет открытые ключи.
Требуется ONTAP 9.7 или более поздней версии; поддерживается только REST.

Требования

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

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

Параметры

Параметр	Описание
account строка / обязательный	Имя учетной записи пользователя.
cert_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
comment строка	Необязательный комментарий к открытому ключу.
delete_all логический	Если индекс не указан, а state=absent, удалить все открытые ключи этой учетной записи пользователя. Варианты: `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, каждый элемент — целое число.
hostname строка / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Заменить порт по умолчанию (80 или 443) указанным портом.
https логический	Включить или отключить HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при использовании аутентификации по сертификату SSL, так как для нее требуется SSL. Варианты: `false` ← (по умолчанию) `true`
index целое число	Индексный номер открытого ключа. Если индекс не указан, а state=present, открытый ключ всегда добавляется с использованием следующего доступного индекса. Если индекс не указан, а state=present, модуль не является идемпотентным. Если индекс не указан, а state=absent, при обнаружении только одного ключа он удаляется. В противном случае выводится сообщение об ошибке. См. также параметр `delete_all`.
key_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
password псевдонимы: pass строка	Пароль указанного пользователя.
public_key строка	Открытый ключ.
state строка	Указывает, должен ли указанный открытый ключ существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_lambda логический добавлено в netapp.ontap 23.4.0	Указывает, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest строка	Этот модуль поддерживает только REST. always — всегда использовать REST API. Если модуль не поддерживает REST, выдается предупреждение. По умолчанию: `"always"`
username псевдонимы: user строка	Это может быть учетная запись уровня кластера или SVM в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по сертификату SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Чтобы использовать сертификат, его необходимо установить в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs логический	Если задано значение `no`, сертификаты SSL не будут проверяться. Задавайте значение `False` только на контролируемых вами узлах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vserver строка	Имя используемого vserver. Не указывайте этот параметр для учетных записей пользователей уровня кластера.

Примечания

Примечание

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

Примеры

- name: Create publickey
  netapp.ontap.na_ontap_publickey:
    state: present
    account: SampleUser
    index: 0
    public_key: "{{ netapp_publickey }}"
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete single publickey
  netapp.ontap.na_ontap_publickey:
    state: absent
    account: SampleUser
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify single publickey
  netapp.ontap.na_ontap_publickey:
    state: present
    account: SampleUser
    comment: ssh key for XXXX
    index: 0
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

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

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

Ключ	Описание
cd_action строка	Указывает, был ли создан или удален открытый ключ. Возвращается: при успехе
modify словарь	Атрибуты, измененные, если ключ уже существует. Возвращается: при успехе

Авторы

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