Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_user — Настройка и управление пользователями NetApp ONTAP

Примечание

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

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

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

Для использования в плейбуке укажите: netapp.ontap.na_ontap_user.

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

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

Описание

  • Создание или удаление пользователей.

Требования

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

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

Параметры

Параметр

Комментарии

application_dicts

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

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

Список приложений, которым необходимо предоставить доступ. Обеспечивает лучший контроль над приложениями и методами аутентификации.

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

Модуль поддерживает оба варианта: service-processor и service_processor.

ZAPI требует service-processor, а REST — service_processor, за исключением проблемы с ONTAP 9.6 и 9.7.

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

Требуется либо application_dicts, либо application_strs.

application

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

имя приложения.

Варианты:

  • "console"
  • "http"
  • "ontapi"
  • "rsh"
  • "snmp"
  • "service_processor"
  • "service-processor"
  • "sp"
  • "ssh"
  • "telnet"

authentication_methods

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

список методов аутентификации для приложения (см. authentication_method).

Варианты:

  • "community"
  • "password"
  • "publickey"
  • "domain"
  • "nsswitch"
  • "usm"
  • "cert"
  • "saml"

second_authentication_method

строка

при использовании ssh, необязательный дополнительный метод аутентификации для MFA.

Варианты:

  • "none"
  • "password"
  • "publickey"
  • "nsswitch"

application_strs

псевдонимы: application, applications

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

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

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

Этот параметр сохраняет обратную совместимость с существующим параметром applications, но ограничен.

Рекомендуется использовать новый параметр application_dicts, который предоставляет большую гибкость.

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

Модуль поддерживает оба варианта: service-processor и service_processor.

ZAPI требует service-processor, а REST — service_processor, за исключением проблемы с ONTAP 9.6 и 9.7.

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

Требуется либо application_dicts, либо application_strs.

Варианты:

  • "console"
  • "http"
  • "ontapi"
  • "rsh"
  • "snmp"
  • "service_processor"
  • "service-processor"
  • "sp"
  • "ssh"
  • "telnet"

authentication_method

строка

Метод аутентификации для приложения. Если вам нужен более одного метода, используйте application_dicts.

Не все методы аутентификации действительны для приложения.

Действительные методы аутентификации для каждого приложения указаны в authentication_choices_description.

Пароль для консольного приложения

Пароль, домен, nsswitch, cert, saml для http-приложения.

Пароль, домен, nsswitch, cert, saml для ontapi-приложения.

SAML поддерживается только с REST, но, похоже, работает и с ZAPI.

Ключевое слово для приложения snmp (при создании пользователей SNMPv1 и SNMPv2).

Ключевое слово и usm для snmp-приложения (при создании пользователей SNMPv3).

Пароль для приложения sp.

Пароль для приложения rsh.

Пароль для приложения telnet.

Пароль, открытый ключ, домен, nsswitch для приложения ssh.

Требуется при наличии application_strs.

Варианты:

  • "community"
  • "password"
  • "publickey"
  • "domain"
  • "nsswitch"
  • "usm"
  • "cert"
  • "saml"

authentication_password

строка

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

Пароль для протокола аутентификации. Он должен быть не менее 8 символов длиной.

Это требуется для протоколов аутентификации «md5», «sha» и «sha2-256» и не требуется для «none».

Доступен только для метода аутентификации «usm» и не может быть изменён.

authentication_protocol

строка

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

Протокол аутентификации для пользователя snmp.

Когда включен кластерный режим FIPS, «sha» и «sha2-256» являются единственными возможными и допустимыми значениями.

Когда кластерный режим FIPS выключен, значение по умолчанию — «none».

Когда кластерный режим FIPS включен, значение по умолчанию — «sha».

Доступен только для метода аутентификации «usm» и не может быть изменён.

Варианты:

  • "none"
  • "md5"
  • "sha"
  • "sha2-256"

cert_filepath

строка

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

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

не поддерживается с python 2.6.

engine_id

строка

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

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

Должен быть указан как шестнадцатеричная строка.

Идентификатор узла с установленным в 1 первым битом в первом октете должен иметь минимум 5 или максимум 32 октета.

Идентификатор узла с установленным в 0 первым битом в первом октете должен иметь длину 12 октетов.

Идентификатор узла не может содержать все нули в своём адресе.

Доступен только для метода аутентификации «usm» и не может быть изменён.

feature_flags

словарь

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

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

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

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

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

key_filepath

строка

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

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

lock_user

булево

Заблокирован ли указанный учетная запись пользователя.

Варианты:

  • false
  • true

name

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

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

ontapi

целое число

Версия API ontap для использования

password

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

строка

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

privacy_password

строка

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

Пароль для протокола конфиденциальности. Он должен быть не менее 8 символов длиной.

Требуется для протоколов конфиденциальности 'des' и 'aes128' и не требуется для 'none'.

Доступно только для метода аутентификации 'usm' и не может быть изменено.

privacy_protocol

строка

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

Протокол конфиденциальности для пользователя snmp.

При включенном режиме FIPS кластера 'aes128' является единственно возможным и допустимым значением.

При выключенном режиме FIPS кластера значение по умолчанию — 'none'. При включенном режиме FIPS кластера значение по умолчанию — 'aes128'.

Доступно только для метода аутентификации 'usm' и не может быть изменено.

Варианты:

  • "none"
  • "des"
  • "aes128"

remote_switch_ipaddress

строка

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

Это необязательно указывает IP-адрес удаленного коммутатора.

Удаленный коммутатор может быть коммутатором кластера, контролируемым монитором состояния коммутатора кластера (CSHM), или коммутатором Fibre Channel (FC), контролируемым монитором состояния кластера Metro (MCC-HM).

Это применимо только для удаленного пользователя SNMPv3, т. е. только если пользователь является удаленным (не локальным) пользователем, приложение — snmp, а метод аутентификации — usm.

replace_existing_apps_and_methods

строка

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

Если пользователь уже существует, при state=present текущие приложения и методы аутентификации заменяются.

Если пользователь уже существует, текущие приложения и методы аутентификации удаляются при state=absent.

При использовании application_dicts или REST это единственное поддерживаемое поведение.

При использовании application_strs и ZAPI это поведение, когда этот параметр установлен в значение always.

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

При использовании application_strs и ZAPI, если параметр установлен в значение auto, методы аутентификации, которые не указаны, не удаляются.

auto сохраняет существующее поведение для обратной совместимости, но обратите внимание, что REST и ZAPI имеют несовместимое поведение.

Это еще одна причина рекомендовать использовать application_dicts.

Варианты:

  • "always"
  • "auto" ← (по умолчанию)

role_name

строка

Имя роли. Требуется, когда state=present

set_password

строка

Пароль для учетной записи пользователя.

Игнорируется при создании пользователей snmp, но требуется для создания пользователей, отличных от snmp.

Для существующего пользователя это значение будет использоваться в качестве нового пароля.

state

строка

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

Варианты:

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

use_rest

string

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

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

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

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

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

username

aliases: user

string

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

Для получения дополнительной информации обратитесь к документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

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

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

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

validate_certs

boolean

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

Это значение следует устанавливать только в False на сайтах с собственными сертификатами.

Варианты:

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

vserver

aliases: svm

string

Имя используемого vserver.

Требуется для ZAPI.

Для REST игнорируйте эту опцию при создании интерфейса на уровне кластера.

Примечания

Примечание

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

Примеры

- name: Create User
  netapp.ontap.na_ontap_user:
    state: present
    name: SampleUser
    applications: ssh,console
    authentication_method: password
    set_password: apn1242183u1298u41
    lock_user: True
    role_name: vsadmin
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create cluster scoped user in REST.
  netapp.ontap.na_ontap_user:
    state: present
    name: SampleUser
    applications: ssh,console
    authentication_method: password
    set_password: apn1242183u1298u41
    lock_user: True
    role_name: admin
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete User
  netapp.ontap.na_ontap_user:
    state: absent
    name: SampleUser
    applications: ssh
    authentication_method: password
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create user with snmp application (ZAPI)
  netapp.ontap.na_ontap_user:
    state: present
    name: test_cert_snmp
    applications: snmp
    authentication_method: usm
    role_name: admin
    authentication_protocol: md5
    authentication_password: '12345678'
    privacy_protocol: 'aes128'
    privacy_password: '12345678'
    engine_id: '7063514941000000000000'
    remote_switch_ipaddress: 10.0.0.0
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Create user
  netapp.ontap.na_ontap_user:
    state: present
    name: test123
    application_dicts:
      - application: http
        authentication_methods: password
      - application: ssh
        authentication_methods: password,publickey
    role_name: vsadmin
    set_password: bobdole1234566
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Авторы

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

Spec-Zone.ru

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