Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_certificate_management_policy — настройка политики управления сертификатами для Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

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

Для установки используйте: ansible-galaxy collection install cisco.intersight.

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_certificate_management_policy.

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

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

  • Управляет настройкой политики управления сертификатами в Cisco Intersight.
  • Политика для настройки управления сертификатами на серверах, управляемых Cisco Intersight.
  • Эта политика позволяет настраивать сертификаты корневого центра сертификации и сертификаты IMC с закрытыми ключами.
  • Дополнительную информацию см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

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

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

Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.

api_private_key

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

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в Intersight API.

Если используется строка, для шифрования строковых данных следует использовать Ansible Vault.

Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.

api_uri

string

URI для доступа к Intersight API.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI.

По умолчанию: "https://intersight.com/api/v1"

certificates

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

Список сертификатов для управления в политике.

Может включать сертификаты корневого центра сертификации и сертификаты IMC.

Для каждой политики можно настроить только один сертификат IMC.

certificate

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

Данные сертификата в кодировке PEM.

Должны быть закодированы в base64.

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

certificate_name

string

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

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

Имя должно начинаться и заканчиваться буквенно-цифровым символом.

В имени можно использовать символы подчёркивания и дефисы.

Длина имени не должна превышать 30 символов.

Обязательно для сертификатов корневого центра сертификации.

certificate_type

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

Тип настраиваемого сертификата.

rootca для сертификатов корневого центра сертификации.

imc для сертификатов IMC (для каждой политики допускается только один).

Варианты:

  • "rootca"
  • "imc"

enabled

boolean

Определяет, включён ли сертификат.

Варианты:

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

private_key

string

Закрытый ключ сертификата в кодировке PEM.

Должен быть закодирован в base64.

Требуется только для сертификатов типа IMC.

description

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

string

Описание политики управления сертификатами, заданное пользователем.

Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или символ подчёркивания (_).

name

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

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

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

string

Имя организации, которой назначен этот ресурс.

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

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

state

string

Если задано present, модуль проверит, что ресурс существует, и при необходимости создаст его.

Если задано absent, модуль проверит, что ресурс отсутствует, и при необходимости удалит его.

Варианты:

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

tags

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

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

use_proxy

boolean

Если задано no, прокси использоваться не будет, даже если он указан в переменной среды на целевых узлах.

Варианты:

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

validate_certs

boolean

Логическое значение, определяющее, проверять ли TLS-сертификат api_uri

Варианты:

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

Примеры

- name: Create Certificate Management Policy with Root CA certificate
  cisco.intersight.intersight_certificate_management_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "CertMgmt-Policy-01"
    description: "Certificate management policy with Root CA"
    certificates:
      - certificate_type: rootca
        certificate_name: "RootCA-01"
        certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
        enabled: true
    state: present

- name: Create Certificate Management Policy with IMC certificate
  cisco.intersight.intersight_certificate_management_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "CertMgmt-Policy-02"
    description: "Certificate management policy with IMC certificate"
    certificates:
      - certificate_type: imc
        certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
        private_key: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQ..."
        enabled: true
    state: present

- name: Create Certificate Management Policy with both types
  cisco.intersight.intersight_certificate_management_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "CertMgmt-Policy-03"
    description: "Certificate management policy with both certificate types"
    certificates:
      - certificate_type: rootca
        certificate_name: "RootCA-01"
        certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
        enabled: true
      - certificate_type: imc
        certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
        private_key: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQ..."
        enabled: true
    state: present

- name: Update policy - remove all certificates
  cisco.intersight.intersight_certificate_management_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "CertMgmt-Policy-01"
    certificates: []
    state: present

- name: Delete Certificate Management Policy
  cisco.intersight.intersight_certificate_management_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "CertMgmt-Policy-01"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Ответ API, возвращённый указанным ресурсом.

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

Пример: {"api_response": {"Certificates": [{"Certificate": {"PemCertificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."}, "CertificateName": "RootCA-01", "Enabled": true, "ObjectType": "certificatemanagement.RootCaCertificate"}], "Description": "Certificate management policy", "Moid": "1234567890abcdef12345678", "Name": "CertMgmt-Policy-01", "ObjectType": "certificatemanagement.Policy", "Tags": [{"Key": "Environment", "Value": "Production"}]}}

Авторы

  • Ron Gershburg (@rgershbu)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/cisco/intersight/intersight_certificate_management_policy_module.html

Spec-Zone.ru

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