модуль cisco.intersight.intersight_kvm_policy — настройка политики виртуального KVM для Cisco Intersight

Примечание

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

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

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

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

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

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

Управляет настройкой политики виртуального KVM в Cisco Intersight.
Политика для настройки параметров виртуального KVM на серверах под управлением Cisco Intersight.
При включении настраивает ограничения сеансов, параметры портов, шифрование и туннелирование.
При отключении настраивается только состояние включения, остальные параметры игнорируются.
Дополнительную информацию см. в документации 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	Описание политики KVM, заданное пользователем. Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или символ подчеркивания (_).
enable_local_server_video boolean	Если включено, сеанс KVM отображается на любом мониторе, подключенном к серверу. Этот параметр игнорируется, если `enabled` имеет значение `false`. Варианты: `false` `true` ← (по умолчанию)
enable_video_encryption boolean	Если включено, шифрует всю видеоинформацию, передаваемую через KVM. Обратите внимание: отключить этот параметр для серверов с версией 4.2 и выше уже нельзя. Этот параметр игнорируется, если `enabled` имеет значение `false`. Варианты: `false` `true` ← (по умолчанию)
enabled boolean	Состояние службы vKVM на конечном устройстве. Если задано значение false, все остальные параметры конфигурации игнорируются и настраивается только состояние включения. Если задано значение true, применяются все остальные параметры конфигурации. Варианты: `false` `true` ← (по умолчанию)
maximum_sessions integer	Максимальное количество одновременных сеансов KVM. Допустимый диапазон: от 1 до 4 сеансов. Этот параметр игнорируется, если `enabled` имеет значение `false`. По умолчанию: `4`
name string / обязательный	Имя, присвоенное политике KVM. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Профили, политики и пулы, созданные в пользовательской организации, применимы только к устройствам в этой же организации. По умолчанию: `"default"`
remote_port integer	Порт для связи KVM. Допустимый диапазон: от 1024 до 65535. Этот параметр игнорируется, если `enabled` имеет значение `false`. По умолчанию: `2068`
state string	Если задано `present`, будет проверено наличие ресурса и при необходимости ресурс будет создан. Если задано `absent`, будет проверено отсутствие ресурса и при необходимости ресурс будет удален. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / elements=dictionary	Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».
tunneled_kvm_enabled boolean	Включает туннелируемый vKVM на конечном устройстве. Применимо только к коннекторам устройств, поддерживающим туннелируемый vKVM. Этот параметр игнорируется, если `enabled` имеет значение `false`. Варианты: `false` ← (по умолчанию) `true`
use_proxy boolean	Если задано `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, управляющий проверкой TLS-сертификата api_uri. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Create an enabled KVM Policy with default settings
  cisco.intersight.intersight_kvm_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Default-KVM-Policy"
    description: "KVM policy with standard settings"
    enabled: true
    tags:
      - Key: "Environment"
        Value: "Production"

- name: Create a KVM Policy with custom settings
  cisco.intersight.intersight_kvm_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Custom-KVM-Policy"
    description: "KVM policy with custom port and session limits"
    enabled: true
    maximum_sessions: 2
    remote_port: 3000
    enable_video_encryption: true
    enable_local_server_video: false
    tunneled_kvm_enabled: true
    tags:
      - Key: "Owner"
        Value: "DevOps"

- name: Create a disabled KVM Policy
  cisco.intersight.intersight_kvm_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Disabled-KVM-Policy"
    description: "Disabled KVM policy for security compliance"
    enabled: false
    tags:
      - Key: "Security"
        Value: "Disabled"

- name: Delete a KVM Policy
  cisco.intersight.intersight_kvm_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Old-KVM-Policy"
    state: absent

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

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

Ключ	Описание
api_response dictionary	Ответ API, возвращенный указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"EnableLocalServerVideo": false, "EnableVideoEncryption": true, "Enabled": true, "MaximumSessions": 2, "Name": "Custom-KVM-Policy", "ObjectType": "kvm.Policy", "RemotePort": 3000, "Tags": [{"Key": "Owner", "Value": "DevOps"}], "TunneledKvmEnabled": true}}`

Ключ

Описание

api_response

dictionary

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

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

Пример: {"api_response": {"EnableLocalServerVideo": false, "EnableVideoEncryption": true, "Enabled": true, "MaximumSessions": 2, "Name": "Custom-KVM-Policy", "ObjectType": "kvm.Policy", "RemotePort": 3000, "Tags": [{"Key": "Owner", "Value": "DevOps"}], "TunneledKvmEnabled": true}}

Авторы

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_kvm_policy_module.html