netapp.ontap.na_ontap_security_certificates – Управление сертификатами безопасности NetApp ONTAP.
Примечание
Этот плагин входит в коллекцию netapp.ontap (версия 20.12.0).
Для его установки используйте: ansible-galaxy collection install netapp.ontap.
Чтобы использовать его в плейбуке, укажите: netapp.ontap.na_ontap_security_certificates.
Новое в версии 20.7.0: модуля netapp.ontap
Обзор
- Установка или удаление сертификатов безопасности на ONTAP. (Создание и подписание будут реализованы во второй итерации)
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
- Поддержка REST требует ONTAP 9.6 или более поздней версии.
- Ansible 2.6
- Сильно рекомендуется Ansible 2.9 или более поздней версии, так как это позволяет использовать новую систему доставки коллекций.
- Python2 netapp-lib (2017.10.30) или более поздней версии. Установите с помощью «pip install netapp-lib»
- Python3 netapp-lib (2018.11.13) или более поздней версии. Установите с помощью «pip install netapp-lib»
- Сильно рекомендуется netapp-lib 2020.3.12, так как он обеспечивает лучшую обработку ошибок при проблемах с подключением.
- Для включения http в кластере необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cert_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу SSL-сертификата клиента (.pem). не поддерживается с python 2.6. | |
| common_name строка | общее имя сертификата. Требуется для создания и установки. Если имя присутствует, игнорируется для подписи и удаления. Если имя отсутствует или игнорируется, требуется для подписи и удаления. | |
| expiry_time строка | Дата истечения срока действия сертификата. Указание даты истечения срока действия рекомендуется при создании сертификата. Можно указать при подписи сертификата. | |
| feature_flags словарь добавлен в 20.5.0 netapp.ontap | Включение или отключение новой функции. Это можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются. | |
| hash_function строка | Функция хеширования. Может быть указана при создании собственноручно подписанного сертификата или при подписи сертификата. Допустимые значения для создания и подписи — sha256, sha224, sha384, sha512. | |
| hostname строка / обязательно | Имя хоста или IP-адрес экземпляра ONTAP. | |
| http_port целое число | Переопределите порт по умолчанию (80 или 443) с помощью этого порта. | |
| https булево |
| Включение и отключение https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при использовании аутентификации по SSL-сертификату, так как она требует SSL. |
| ignore_name_if_not_supported булево добавлен в 20.8.0 netapp.ontap |
| API REST ONTAP 9.6 и 9.7 не поддерживает name. Если установлено в значение «да», об ошибке не сообщается, если name присутствует, и name не используется. |
| intermediate_certificates список / элементы=строка | Цепочка промежуточных сертификатов в формате PEM. Действительно только при установке сертификата. | |
| key_filepath строка добавлен в 20.6.0 netapp.ontap | путь к файлу закрытого ключа SSL клиента. | |
| key_size целое число | Размер ключа сертификата в битах. Рекомендуется указывать сильный размер ключа при создании сертификата. Игнорируется при подписи и удалении. | |
| name строка | Уникальное имя сертификата безопасности для каждого SVM. Этот параметр не поддерживается для ONTAP 9.6 или 9.7, так как REST API его не поддерживает. Если он присутствует с ONTAP 9.6 или 9.7, он игнорируется по умолчанию, см. ignore_name_if_not_supported. Для более новых релизов ONTAP настоятельно рекомендуется использовать имя. | |
| ontapi целое число | Используемая версия API ontap | |
| password строка | Пароль для указанного пользователя. псевдонимы: pass | |
| private_key строка | Закрытый ключ сертификата в формате PEM. Требуется при установке подписанного CA-сертификата. В противном случае игнорируется. | |
| public_certificate строка | Открытый ключ сертификата в формате PEM. Требуется при установке сертификата. В противном случае игнорируется. | |
| signing_request строка | Если указано, используется сертификат, идентифицируемый именем и svm, для подписи запроса. Возвращается подписанный сертификат. | |
| state строка |
| Указывает, должен ли указанный сертификат безопасности существовать или нет. |
| svm строка | Имя SVM (vserver). Если указано, сертификат устанавливается в SVM. Если отсутствует, сертификат устанавливается в кластере. псевдонимы: vserver | |
| type строка |
| Тип сертификата Требуется для создания и установки. Если имя присутствует, игнорируется при подписи и удалении. Если имя отсутствует или игнорируется, требуется при подписи и удалении. |
| use_rest строка | По умолчанию: "auto" | REST API, если поддерживается целевой системой для всех ресурсов и атрибутов, необходимых модулю. В противном случае возвращается к ZAPI. всегда — всегда будет использовать REST API никогда — всегда будет использовать ZAPI авто — будет пытаться использовать REST API |
| username строка | Это может быть учетная запись уровня кластера или SVM, в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации 1. Аутентификация по имени пользователя и паролю 2. Аутентификация по SSL-сертификату, используя файл SSL-сертификата клиента и, необязательно, файл закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификату. псевдонимы: user | |
| validate_certs булево |
| Если установлено в no, SSL-сертификаты не будут проверяться.Это следует устанавливать только в False на сайтах, управляемых самостоятельно, используя собственные подписанные сертификаты. |
Примечания
Примечание
- Модули с префиксом na_ontap разработаны для поддержки платформы хранения ONTAP.
Примеры
- name: install certificate
na_ontap_security_certificates:
# <<: *cert_login
common_name: "{{ ontap_cert_common_name }}"
name: "{{ ontap_cert_name }}"
public_certificate: "{{ ssl_certificate }}"
type: client_ca
svm: "{{ vserver }}"
- name: create certificate
na_ontap_security_certificates:
# <<: *cert_login
common_name: "{{ ontap_cert_root_common_name }}"
name: "{{ ontap_cert_name }}"
type: root_ca
svm: "{{ vserver }}"
expiry_time: P365DT # one year
- name: sign certificate using newly create certificate
tags: sign_request
na_ontap_security_certificates:
# <<: *login
name: "{{ ontap_cert_name }}"
svm: "{{ vserver }}"
signing_request: |
-----BEGIN CERTIFICATE REQUEST-----
MIIChDCCAWwCAQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQH
DAlTdW5ueXZhbGUxDzANBgNVBAoMBk5ldEFwcDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBALgXCj6Si/I4xLdV7wjWYTbt8jY20fQOjk/4E7yBT1vFBflE
ks6YDc6dhC2G18cnoj9E3DiR8lIHPoAlFB/VmBNDev3GZkbFlrbV7qYmf8OEx2H2
tAefgSP0jLmCHCN1yyhJoCG6FsAiD3tf6yoyFF6qS9ureGL0tCJJ/osx64WzUz+Q
EN8lx7VSxriEFMSjreXZDhUFaCdIYKKRENuEWyYvdy5cbBmczhuM8EP6peOVv5Hm
BJzPUDkq7oTtEHmttpATq2Y92qzNzETO0bXN5X/93AWri8/yEXdX+HEw1C/omtsE
jGsCXrCrIJ+DgUdT/GHNdBWlXl/cWGtEgEQ4vrUCAwEAAaAAMA0GCSqGSIb3DQEB
CwUAA4IBAQBjZNoQgr/JDm1T8zyRhLkl3zw4a16qKNu/MS7prqZHLVQgrptHRegU
Hbz11XoHfVOdbyuvtzEe95QsDd6FYCZ4qzZRF3se4IjMeqwdQZ5WP0/GFiwM8Uln
/0TCWjt759XMeUX7+wgOg5NRjJ660eWMXzu/UJf+vZO0Q2FiPIr13JvvY3TjT+9J
UUtK4r9PaUuOPN2YL9IQqSD3goh8302Qr3nBXUgjeUGLkgfUM5S39apund2hyTX2
JCLQsKr88pwU9iDho2tHLv/2QgLwNZLPu8V+7IGu6G4vB28lN4Uy7xbhxFOKtyWu
fK4sEdTw3B/aDN0tB8MHFdPYycNZsEac
-----END CERTIFICATE REQUEST-----
expiry_time: P180DT
- name: delete certificate
na_ontap_security_certificates:
# <<: *cert_login
state: absent
name: "{{ ontap_cert_name }}"
svm: "{{ vserver }}"
# For ONTAP 9.6 or 9.7, use common_name and type, in addition to, or in lieu of name
- name: install certificate
na_ontap_security_certificates:
# <<: *cert_login
common_name: "{{ ontap_cert_common_name }}"
public_certificate: "{{ ssl_certificate }}"
type: client_ca
svm: "{{ vserver }}"
- name: create certificate
na_ontap_security_certificates:
# <<: *cert_login
common_name: "{{ ontap_cert_root_common_name }}"
type: root_ca
svm: "{{ vserver }}"
expiry_time: P365DT # one year
- name: sign certificate using newly create certificate
tags: sign_request
na_ontap_security_certificates:
# <<: *login
common_name: "{{ ontap_cert_root_common_name }}"
type: root_ca
svm: "{{ vserver }}"
signing_request: |
-----BEGIN CERTIFICATE REQUEST-----
MIIChDCCAWwCAQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQH
DAlTdW5ueXZhbGUxDzANBgNVBAoMBk5ldEFwcDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBALgXCj6Si/I4xLdV7wjWYTbt8jY20fQOjk/4E7yBT1vFBflE
ks6YDc6dhC2G18cnoj9E3DiR8lIHPoAlFB/VmBNDev3GZkbFlrbV7qYmf8OEx2H2
tAefgSP0jLmCHCN1yyhJoCG6FsAiD3tf6yoyFF6qS9ureGL0tCJJ/osx64WzUz+Q
EN8lx7VSxriEFMSjreXZDhUFaCdIYKKRENuEWyYvdy5cbBmczhuM8EP6peOVv5Hm
BJzPUDkq7oTtEHmttpATq2Y92qzNzETO0bXN5X/93AWri8/yEXdX+HEw1C/omtsE
jGsCXrCrIJ+DgUdT/GHNdBWlXl/cWGtEgEQ4vrUCAwEAAaAAMA0GCSqGSIb3DQEB
CwUAA4IBAQBjZNoQgr/JDm1T8zyRhLkl3zw4a16qKNu/MS7prqZHLVQgrptHRegU
Hbz11XoHfVOdbyuvtzEe95QsDd6FYCZ4qzZRF3se4IjMeqwdQZ5WP0/GFiwM8Uln
/0TCWjt759XMeUX7+wgOg5NRjJ660eWMXzu/UJf+vZO0Q2FiPIr13JvvY3TjT+9J
UUtK4r9PaUuOPN2YL9IQqSD3goh8302Qr3nBXUgjeUGLkgfUM5S39apund2hyTX2
JCLQsKr88pwU9iDho2tHLv/2QgLwNZLPu8V+7IGu6G4vB28lN4Uy7xbhxFOKtyWu
fK4sEdTw3B/aDN0tB8MHFdPYycNZsEac
-----END CERTIFICATE REQUEST-----
expiry_time: P180DT
- name: delete certificate
na_ontap_security_certificates:
# <<: *cert_login
state: absent
common_name: "{{ ontap_cert_root_common_name }}"
type: root_ca
name: "{{ ontap_cert_name }}"
svm: "{{ vserver }}"
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ontap_info словарь | всегда | Возвращает public_certificate при подписи, пустое значение для создания, установки и удаления. Пример: { "ontap_info": { "public_certificate": "-----BEGIN CERTIFICATE----- ........-----END CERTIFICATE----- " } } |
Авторы
- Команда Ansible NetApp (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_security_certificates_module.html