Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_ipmi_over_lan_policy — настройка политики IPMI over LAN для Cisco Intersight

Примечание

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

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

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

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

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

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

  • Управляет настройкой политики IPMI over LAN в Cisco Intersight.
  • Политика для настройки параметров IPMI over LAN на серверах, управляемых Cisco Intersight.
  • IPMI over LAN позволяет управлять серверами с помощью протокола IPMI через сети Ethernet.
  • Дополнительные сведения см. в 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

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

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

enabled

boolean

Состояние службы IPMI over LAN на конечном устройстве.

Включение или отключение функции IPMI over LAN на сервере.

Варианты:

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

encryption_key

string

Ключ шифрования для обмена данными по IPMI.

Он должен содержать чётное число шестнадцатеричных символов и не превышать 40 символов.

Чтобы отключить использование ключа шифрования, укажите «00».

Эта настройка поддерживается всеми автономными серверами C-Series.

Серверы C-Series, подключённые к FI, поддерживают эту настройку при наличии прошивки версии не ниже 4.2.3a.

Серверы B/X-Series поддерживают эту настройку при наличии прошивки версии не ниже 5.1.0.x.

При выполнении команд IPMI с этим ключом следует дополнить его нулями до длины 40 символов.

name

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

Имя, назначенное политике IPMI over LAN.

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

organization

string

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

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

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

privilege

string

Максимальный уровень привилегий, который можно назначить сеансу IPMI на сервере.

Эта настройка поддерживается всеми автономными серверами C-Series.

Серверы C-Series, подключённые к FI, поддерживают эту настройку при наличии прошивки версии не ниже 4.2.3a.

Серверы B/X-Series поддерживают эту настройку при наличии прошивки версии не ниже 5.1.0.x.

Уровень привилегий ‘user’ не поддерживается на серверах B/X-Series.

Варианты:

  • "admin" ← (по умолчанию)
  • "user"
  • "read-only"

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 IPMI over LAN Policy with encryption enabled
  cisco.intersight.intersight_ipmi_over_lan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "IPMI-Policy-Encrypted"
    description: "IPMI over LAN policy with encryption"
    enabled: true
    privilege: "admin"
    encryption_key: "AB2134AC"
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    state: present

- name: Create IPMI over LAN Policy with encryption disabled
  cisco.intersight.intersight_ipmi_over_lan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "IPMI-Policy-No-Encryption"
    description: "IPMI over LAN policy without encryption"
    enabled: true
    privilege: "operator"
    encryption_key: "00"
    state: present

- name: Create disabled IPMI over LAN Policy
  cisco.intersight.intersight_ipmi_over_lan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "IPMI-Policy-Disabled"
    description: "Disabled IPMI over LAN policy"
    enabled: false
    state: present

- name: Delete IPMI over LAN Policy
  cisco.intersight.intersight_ipmi_over_lan_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "IPMI-Policy-Encrypted"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Выходные данные ответа API, возвращённые указанным ресурсом.

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

Пример: {"api_response": {"Enabled": true, "IsEncryptionKeySet": true, "Name": "IPMI-Policy-Encrypted", "ObjectType": "ipmioverlan.Policy", "Privilege": "admin", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}

Авторы

  • 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_ipmi_over_lan_policy_module.html

Spec-Zone.ru

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