Модуль cisco.intersight.intersight_rest_api – Конфигурация REST API для Cisco Intersight

Примечание

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

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

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

Для использования в playbook, укажите: cisco.intersight.intersight_rest_api.

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

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

Прямая конфигурация REST API для Cisco Intersight.
Необходимо указать все ресурсы и свойства REST API.
Для получения дополнительной информации см. Cisco Intersight.

Параметры

Параметр	Комментарии
api_body словарь	Полезная нагрузка для API-запросов, используемых для изменения ресурсов.
api_key_id строка / обязательно	Публичный ID API-ключа, связанный с закрытым ключом. Если не указано, используется значение переменной окружения INTERSIGHT_API_KEY_ID.
api_private_key путь / обязательно	Имя файла (абсолютный путь) или строка данных закрытого ключа в формате 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 строка	URI, используемый для доступа к API Intersight. Если не указано, используется значение переменной окружения INTERSIGHT_API_URI. Значение по умолчанию: `"https://intersight.com/api/v1"`
list_body список / элементы=словарь	Полезная нагрузка для API-запросов, используемых для изменения ресурсов. Следует использовать вместо api_body, если в полезной нагрузке API требуется список.
query_params словарь	Параметры запроса для языка запросов Intersight API.
resource_path строка / обязательно	URI ресурса, настраиваемого относительно api_uri.
return_list булево	Если `yes`, вернет список результатов API в api_response. По умолчанию возвращается только первый элемент списка результатов API. Может использоваться только с операциями GET. Варианты: `false` ← (по умолчанию) `true`
state строка	Если `present`, проверит наличие ресурса и создаст его при необходимости. Если `absent`, проверит отсутствие ресурса и удалит его при необходимости. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_method строка	HTTP-метод, используемый для операций обновления. Некоторые ресурсы Intersight требуют операций POST для модификаций. json-patch используется для частичных обновлений. json-patch поддерживается только для операций patch на существующих ресурсах и требует, чтобы list_body был списком словарей. См. Документацию по API Intersight для получения подробной информации о JSON Patch. Варианты: `"patch"` ← (по умолчанию) `"post"` `"json-patch"`
use_proxy булево	Если `no`, прокси использоваться не будет, даже если он определен в переменной окружения на целевых хостах. Варианты: `false` `true` ← (по умолчанию)
validate_certs булево	Булево управление проверкой сертификата TLS api_uri Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Configure Boot Policy
  intersight_rest_api:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    api_key_uri: "{{ api_key_uri }}"
    validate_certs: "{{ validate_certs }}"
    resource_path: /boot/PrecisionPolicies
    query_params:
      $filter: "Name eq 'vmedia-localdisk'"
    api_body: {
      "Name": "vmedia-localdisk",
      "ConfiguredBootMode": "Legacy",
      "BootDevices": [
        {
          "ObjectType": "boot.VirtualMedia",
          "Enabled": true,
          "Name": "remote-vmedia",
          "Subtype": "cimc-mapped-dvd"
        },
        {
          "ObjectType": "boot.LocalDisk",
          "Enabled": true,
          "Name": "localdisk",
          "Slot": "MRAID",
          "Bootloader": null
        }
      ],
    }
    state: present

- name: Delete Boot Policy
  intersight_rest_api:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    api_key_uri: "{{ api_key_uri }}"
    validate_certs: "{{ validate_certs }}"
    resource_path: /boot/PrecisionPolicies
    query_params:
      $filter: "Name eq 'vmedia-localdisk'"
    state: absent

Значения возврата

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

Ключ	Описание
api_repsonse словарь	Выходные данные ответа API, возвращаемые указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"BootDevices": [{"Enabled": true, "Name": "remote-vmedia", "ObjectType": "boot.VirtualMedia", "Subtype": "cimc-mapped-dvd"}, {"Bootloader": null, "Enabled": true, "Name": "boot-lun", "ObjectType": "boot.LocalDisk", "Slot": "MRAID"}], "ConfiguredBootMode": "Legacy", "Name": "vmedia-localdisk", "ObjectType": "boot.PrecisionPolicy"}}`

Ключ

Описание

api_repsonse

словарь

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

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

Пример: {"api_response": {"BootDevices": [{"Enabled": true, "Name": "remote-vmedia", "ObjectType": "boot.VirtualMedia", "Subtype": "cimc-mapped-dvd"}, {"Bootloader": null, "Enabled": true, "Name": "boot-lun", "ObjectType": "boot.LocalDisk", "Slot": "MRAID"}], "ConfiguredBootMode": "Legacy", "Name": "vmedia-localdisk", "ObjectType": "boot.PrecisionPolicy"}}

Авторы

David Soper (@dsoper2)
CiscoUcs (@CiscoUcs)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/intersight/intersight_rest_api_module.html