Spec-Zone.ru › Ansible

Модуль cisco.intersight.intersight_drive_security_policy — настройка политики безопасности дисков для Cisco Intersight

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.intersight.

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

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

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

  • Управляет настройкой политики безопасности дисков в Cisco Intersight.
  • Политика настройки параметров безопасности дисков на серверах, управляемых Cisco Intersight.
  • Поддерживается управление ключами вручную и удалённое управление ключами (KMIP).
  • Дополнительную информацию см. в Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

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

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

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

api_private_key

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

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

Если используется строка, для шифрования строковых данных следует использовать 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 для доступа к API Intersight.

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

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

description

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

string

Описание политики безопасности дисков, заданное пользователем.

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

manual_key

dictionary

Настройки управления ключами вручную.

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

Необходимо указать либо manual_key, либо remote_key, но не оба параметра одновременно.

existing_key

string

Текущая парольная фраза ключа безопасности, уже настроенная на сервере.

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

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

new_key

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

Новая парольная фраза ключа безопасности для настройки на сервере.

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

name

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

Имя, присвоенное политике безопасности дисков.

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

organization

string

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

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

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

remote_key

dictionary

Настройки удалённого управления ключами с использованием сервера KMIP.

Используйте этот параметр для удалённого управления ключами по протоколу KMIP.

Необходимо указать либо manual_key, либо remote_key, но не оба параметра одновременно.

existing_key

string

Текущая парольная фраза ключа безопасности, уже настроенная на сервере.

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

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

password

string

Пароль для входа на сервер KMIP.

Необязательный параметр для аутентификации KMIP.

primary_server

dictionary

Настройки основного сервера KMIP.

Должен быть включён как минимум один из параметров primary_server и secondary_server.

enable_drive_security

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

Включает или отключает основной сервер KMIP.

Допустимые значения:

  • false
  • true

ip_address

string

IP-адрес или имя хоста сервера KMIP.

Может быть адресом IPv4, адресом IPv6 или именем хоста.

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

Обязателен, если enable_drive_security имеет значение true.

port

integer

Порт, к которому должен подключаться клиент KMIP.

Допустимый диапазон: 1024–65535.

По умолчанию: 5696

timeout

integer

Время ожидания подключения клиента KMIP.

Допустимый диапазон: 1–250 секунд.

По умолчанию: 60

secondary_server

dictionary

Настройки резервного сервера KMIP.

Должен быть включён как минимум один из параметров primary_server и secondary_server.

enable_drive_security

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

Включает или отключает резервный сервер KMIP.

Допустимые значения:

  • false
  • true

ip_address

string

IP-адрес или имя хоста сервера KMIP.

Может быть адресом IPv4, адресом IPv6 или именем хоста.

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

Обязателен, если enable_drive_security имеет значение true.

port

integer

Порт, к которому должен подключаться клиент KMIP.

Допустимый диапазон: 1024–65535.

По умолчанию: 5696

timeout

integer

Время ожидания подключения клиента KMIP.

Допустимый диапазон: 1–250 секунд.

По умолчанию: 60

server_certificate

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

Открытый корневой сертификат CA сервера в формате Base64.

Обязателен при использовании удалённого управления ключами (KMIP).

use_authentication

boolean

Включает или отключает аутентификацию при обмене данными с сервером KMIP.

Если аутентификация включена, она обязательна.

Допустимые значения:

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

username

string

Имя пользователя для входа на сервер KMIP.

Обязателен, если use_authentication имеет значение true.

state

string

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

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

Допустимые значения:

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

tags

list / elements=dictionary

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

По умолчанию: []

use_proxy

boolean

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

Допустимые значения:

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

validate_certs

boolean

Логический параметр для проверки сертификата TLS адреса api_uri

Допустимые значения:

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

Примеры

- name: Create Drive Security Policy with Manual Key
  cisco.intersight.intersight_drive_security_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "manual-drive-security-policy"
    description: "Drive security policy with manual key management"
    manual_key:
      new_key: "MyS3cur3P@ssw0rd"
    tags:
      - Key: "Environment"
        Value: "Production"
    state: present

- name: Create Drive Security Policy with Manual Key (updating existing)
  cisco.intersight.intersight_drive_security_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "manual-drive-security-policy"
    description: "Drive security policy with manual key management"
    manual_key:
      new_key: "MyN3wS3cur3P@ssw0rd"
      existing_key: "MyS3cur3P@ssw0rd"
    state: present

- name: Create Drive Security Policy with KMIP (Primary Server Only)
  cisco.intersight.intersight_drive_security_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "kmip-drive-security-policy"
    description: "Drive security policy with KMIP"
    remote_key:
      primary_server:
        enable_drive_security: true
        ip_address: "192.168.1.100"
        port: 5696
        timeout: 60
      secondary_server:
        enable_drive_security: false
      server_certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
      use_authentication: false
    state: present

- name: Create Drive Security Policy with KMIP (Both Servers with Authentication)
  cisco.intersight.intersight_drive_security_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "kmip-auth-drive-security-policy"
    description: "Drive security policy with KMIP and authentication"
    remote_key:
      primary_server:
        enable_drive_security: true
        ip_address: "192.168.1.100"
        port: 5696
        timeout: 60
      secondary_server:
        enable_drive_security: true
        ip_address: "192.168.1.101"
        port: 5696
        timeout: 60
      server_certificate: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0t..."
      use_authentication: true
      username: "kmip_user"
      password: "kmip_password"
    state: present

- name: Delete Drive Security Policy
  cisco.intersight.intersight_drive_security_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "manual-drive-security-policy"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

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

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

Пример: {"api_response": {"Description": "Drive security policy with manual key management", "KeySetting": {"ClassId": "storage.KeySetting", "KeyType": "Manual", "ManualKey": {"ClassId": "storage.LocalKeySetting", "IsExistingKeySet": false, "IsNewKeySet": true, "ObjectType": "storage.LocalKeySetting"}, "ObjectType": "storage.KeySetting", "RemoteKey": {"AuthCredentials": {"ClassId": "storage.KmipAuthCredentials", "IsPasswordSet": false, "ObjectType": "storage.KmipAuthCredentials", "UseAuthentication": false, "Username": ""}, "ClassId": "storage.RemoteKeySetting", "IsExistingKeySet": false, "ObjectType": "storage.RemoteKeySetting", "PrimaryServer": {"ClassId": "storage.KmipServer", "EnableDriveSecurity": false, "IpAddress": "", "ObjectType": "storage.KmipServer", "Port": 5696, "Timeout": 60}, "SecondaryServer": {"ClassId": "storage.KmipServer", "EnableDriveSecurity": false, "IpAddress": "", "ObjectType": "storage.KmipServer", "Port": 5696, "Timeout": 60}, "ServerCertificate": ""}}, "Name": "manual-drive-security-policy", "ObjectType": "storage.DriveSecurityPolicy", "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_drive_security_policy_module.html

Spec-Zone.ru

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