cisco.intersight.intersight_rest_api – REST API настройка для Cisco Intersight

Примечание

Этот плагин входит в коллекцию cisco.intersight (версия 1.0.9).

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

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

Введено в версии 2.8: модуля cisco.intersight

Описание
Параметры
Примеры
Значения возврата

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_body словарь		Тело запроса API, используемое для изменения ресурсов.
api_key_id строка / обязательно		Идентификатор публичного API ключа, связанный с закрытым ключом.
api_private_key путь / обязательно		Имя файла (абсолютный путь) в формате PEM, содержащий ваш закрытый ключ для аутентификации в API Intersight.
api_uri строка	По умолчанию: "https://intersight.com/api/v1"	URI для доступа к API Intersight.
query_params словарь		Параметры запроса для языка запросов API Intersight.
resource_path строка / обязательно		URI ресурса, настраиваемого в отношении api_uri.
return_list логический	Варианты: нет ← да	Если `yes`, вернёт список результатов API в api_response. По умолчанию возвращается только первый элемент списка результатов API. Может использоваться только с операциями GET.
state строка	Варианты: present ← absent	Если `present`, проверит наличие ресурса и создаст его при необходимости. Если `absent`, проверит отсутствие ресурса и удалит его при необходимости.
update_method строка	Варианты: patch ← post	HTTP-метод, используемый для операций обновления. Для некоторых ресурсов Intersight требуется использование POST-операций для модификаций.
use_proxy логический	Варианты: нет да ←	Если `no`, не будет использовать прокси, даже если он определён в переменной среды на целевых хостах.
validate_certs логический	Варианты: нет да ←	Логический контроль для проверки сертификата TLS api_uri

Примеры

- 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': None, '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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/intersight/intersight_rest_api_module.html