Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_security_certificates — управление сертификатами безопасности 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_certificates.

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

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

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

  • Установка или удаление сертификатов безопасности в ONTAP. (Создание и подписание будут добавлены в следующей итерации.)

Требования

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

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

Параметры

Параметр

Комментарии

algorithm

string

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

Алгоритм асимметричного шифрования.

Варианты:

  • "rsa" ← (по умолчанию)
  • "ec"

cert_filepath

string

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

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

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

common_name

string

Общее имя сертификата.

Обязателен для создания и установки.

Если указан параметр name, при подписании и удалении игнорируется.

Если параметр name отсутствует или игнорируется, он обязателен для подписания и удаления.

expiry_time

string

Время истечения срока действия сертификата. При создании сертификата рекомендуется указывать время истечения срока действия.

Можно указать при подписании сертификата.

extended_key_usages

list / элементы=string

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

Список расширений для использования ключа.

Варианты:

  • "serverauth"
  • "clientauth"
  • "timestamping"
  • "dvcs"
  • "ocspsigning"
  • "codesigning"
  • "emailprotection"
  • "anyextendedkeyusage"
  • "critical"

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.

generate_csr

boolean

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

Создать запрос на подписание сертификата (CSR) вместо создания или установки сертификата.

Если значение равно true, CSR создается на основе указанных параметров и возвращается в выходных данных.

Варианты:

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

hash_function

string

Хеш-функция. Можно указать при создании самоподписанного сертификата, подписании сертификата или создании запроса на подписание сертификата.

Допустимые значения: sha1, sha224, sha256, sha384 и sha512.

Варианты:

  • "sha1"
  • "sha224"
  • "sha256" ← (по умолчанию)
  • "sha384"
  • "sha512"

hostname

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

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

http_port

integer

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

https

boolean

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

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

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

Варианты:

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

ignore_name_if_not_supported

boolean

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

REST API в ONTAP 9.6 и 9.7 не поддерживает параметр name.

Если задано значение true, при наличии параметра name ошибка не возникает, а сам параметр name не используется.

Варианты:

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

intermediate_certificates

list / элементы=string

Цепочка промежуточных сертификатов в формате PEM.

Допустимо только при установке сертификата.

key_filepath

string

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

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

key_size

integer

Размер ключа сертификата в битах. При создании сертификата рекомендуется указывать надежный размер ключа.

Игнорируется при подписании и удалении.

key_usages

list / элементы=string

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

Список расширений для использования ключа.

Варианты:

  • "digitalsignature"
  • "nonrepudiation"
  • "keyencipherment"
  • "dataencipherment"
  • "keyagreement"
  • "keycertsign"
  • "crlsign"
  • "encipheronly"
  • "decipheronly"
  • "critical"

name

string

Уникальное имя сертификата безопасности в пределах SVM.

Этот параметр не поддерживается в ONTAP 9.6 и 9.7, поскольку REST API его не поддерживает.

Если параметр указан для ONTAP 9.6 или 9.7, по умолчанию он игнорируется; см. ignore_name_if_not_supported.

Для более новых выпусков ONTAP настоятельно рекомендуется использовать параметр name.

ontapi

integer

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

password

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

string

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

private_key

string

Сертификат с закрытым ключом в формате PEM.

Обязателен при установке сертификата, подписанного центром сертификации. В остальных случаях игнорируется.

public_certificate

string

Сертификат с открытым ключом в формате PEM.

Обязателен при установке сертификата. В остальных случаях игнорируется.

security_strength

integer

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

Криптостойкость сертификата в битах.

Варианты:

  • 112 ← (по умолчанию)
  • 128
  • 192

signing_request

string

Если параметр указан, для подписания запроса используется сертификат, определяемый параметрами name и svm.

Возвращается подписанный сертификат.

state

string

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

Варианты:

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

subject_alternatives

dictionary

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

Альтернативные имена субъекта сертификата.

dns

list / элементы=string

Список альтернативных DNS-имен субъекта.

email

list / элементы=string

Список альтернативных адресов электронной почты субъекта.

ip

list / элементы=string

Список альтернативных IP-адресов субъекта.

uri

list / элементы=string

Список альтернативных URI субъекта.

subject_name

string

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

Сведения об имени субъекта сертификата. Формат — список пар «ключ=значение», разделенных запятыми.

svm

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

string

Имя SVM (vserver).

Если параметр указан, сертификат устанавливается в SVM.

Если параметр не указан, сертификат устанавливается в кластере.

type

string

Тип сертификата.

Обязателен для создания и установки.

Если указан параметр name, при подписании и удалении игнорируется.

Если параметр name отсутствует или игнорируется, он обязателен для подписания и удаления.

Варианты:

  • "client"
  • "server"
  • "client_ca"
  • "server_ca"
  • "root_ca"

use_lambda

boolean

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

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

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

Варианты:

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

use_rest

string

Указывает, следует ли использовать REST или ZAPI.

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

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

auto — попытаться использовать REST API, если модуль его поддерживает и параметры модуля совместимы с ним. В противном случае выполняется переход на 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 ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: install certificate
  netapp.ontap.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 }}"

# ignore svm option for cluster/admin vserver.
- name: install certificate in cluster vserver.
  netapp.ontap.na_ontap_security_certificates:
    # <<: *cert_login
    common_name: "{{ ontap_cert_common_name }}"
    name: "{{ ontap_cert_name }}"
    public_certificate: "{{ ssl_certificate }}"
    type: client_ca

- name: create certificate
  netapp.ontap.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: Create Certificate Signing Request
  tags: sign_request
  netapp.ontap.na_ontap_security_certificates:
    # <<: *login
    generate_csr: true
    subject_name: "C=US,O=NTAP,CN=test.domain.com"
    security_strength: 128
    hash_function: "sha256"
    algorithm: "rsa"
    name: "test_cert"
    key_usages: "digitalsignature,keyencipherment"
    extended_key_usages: "serverauth,clientauth"
    subject_alternatives:
      dns:
        - main.example.com
        - www.example.com
        - api.example.com
      email:
        - admin@example.com
        - security@example.com
      ip:
        - 192.168.1.100
        - 10.0.0.50
      uri:
        - https://example.com
        - https://api.example.com

- name: sign certificate using newly create certificate
  tags: sign_request
  netapp.ontap.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
  netapp.ontap.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
  netapp.ontap.na_ontap_security_certificates:
    # <<: *cert_login
    common_name: "{{ ontap_cert_common_name }}"
    public_certificate: "{{ ssl_certificate }}"
    type: client_ca
    svm: "{{ vserver }}"

- name: create certificate
  netapp.ontap.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
  netapp.ontap.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
  netapp.ontap.na_ontap_security_certificates:
    # <<: *cert_login
    state: absent
    common_name: "{{ ontap_cert_root_common_name }}"
    type: root_ca
    name: "{{ ontap_cert_name }}"
    svm: "{{ vserver }}"

- name: install certificate - server certificate with chain of intermediate certificates
  netapp.ontap.na_ontap_security_certificates:
    # <<: *cert_login
    common_name: "{{ ontap_cert_common_name }}"
    public_certificate: "{{ ssl_certificate }}"
    type: server
    svm: "{{ vserver }}"
    private_key: "-----BEGIN CERTIFICATE-----
Private Key
-----END CERTIFICATE-----"
    intermediat_certificates: ["-----BEGIN CERTIFICATE-----
Intermediate certificate1
-----END CERTIFICATE-----",
                               "-----BEGIN CERTIFICATE-----
Intermediate certificate2
-----END CERTIFICATE-----",
                               "-----BEGIN CERTIFICATE-----
Root certificate
-----END CERTIFICATE-----"]

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

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

Ключ

Описание

ontap_info

dictionary

При подписании возвращает public_certificate; при создании, установке и удалении возвращает пустое значение.

Возвращается: всегда

Пример: {"ontap_info": {"public_certificate": "-----BEGIN CERTIFICATE----- ........-----END CERTIFICATE----- "}}

Авторы

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

Spec-Zone.ru

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