netapp.ontap.na_ontap_publickey модуль — Настройка публичных ключей NetApp ONTAP

Примечание

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

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

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

Для использования в playbook, укажите: netapp.ontap.na_ontap_publickey.

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

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

Ansible 2.9 или более поздняя версия — рекомендуется 2.12 или более поздняя.
Python3 — рекомендуется 3.9 или более поздняя версия.
При использовании ZAPI, netapp-lib 2018.11.13 или более поздняя версия (установить с помощью ‘pip install netapp-lib’), сильно рекомендуется netapp-lib 2020.3.12, поскольку она обеспечивает лучшие сообщения об ошибках для проблем с подключением
физическая или виртуальная кластеризованная система 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, где каждый элемент — целое число. Когда `use_rest` установлено в auto, это может привести к переключению на ZAPI в зависимости от версии и возможностей платформы. Игнорируется с ZAPI.
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-клиента.
ontapi целое число	Используемая версия ontap API
password псевдонимы: pass строка	Пароль для указанного пользователя.
public_key строка	Открытый ключ.
state строка	Требуется ли существование указанного открытого ключа. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_rest строка	Использовать REST или ZAPI. always – всегда использовать REST API, если модуль его поддерживает. Выдается предупреждение, если модуль не поддерживает REST. Выдается ошибка, если параметр модуля не поддерживается REST. never – всегда использовать ZAPI, если модуль его поддерживает. Возможна ошибка, если параметр REST не поддерживается ZAPI. auto – попытаться использовать REST API, если модуль его поддерживает и параметры модуля поддерживаются. В противном случае переходит к ZAPI. По умолчанию: `"auto"`
username псевдонимы: user строка	Это может быть учетная запись на уровне кластера или SVM, в зависимости от того, требуется ли API на уровне кластера или SVM. Для получения дополнительной информации см. документацию https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации: аутентификация по протоколу basic, используя имя пользователя и пароль, аутентификация по SSL-сертификату, используя файл ssl-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата, он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификату.

validate_certs boolean	Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `False` на сайтах с собственной подписью сертификатов. Варианты: `false` `true` ← (по умолчанию)
vserver string	Имя vserver для использования. Опустите этот параметр для учетных записей пользователей, относящихся к кластеру.

Примечания

Примечание

Этот модуль поддерживает режим проверки (check_mode).
Этот модуль не идемпотентен, если параметр index опущен.
Модули, начинающиеся с 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 string	указывает на создание или удаление открытого ключа. Возвращаемое значение: success
modify dictionary	атрибуты, которые были изменены, если ключ уже существует. Возвращаемое значение: success

Авторы

Команда NetApp Ansible (@carchi8py)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_publickey_module.html