модуль cisco.intersight.intersight_rest_api — настройка REST API для Cisco Intersight

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
api_body dictionary	Данные для запросов API, используемых для изменения ресурсов.
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"`
list_body list / элементы=dictionary	Данные для запросов API, используемых для изменения ресурсов. Если в полезной нагрузке API требуется список, этот параметр следует использовать вместо api_body.
query_params dictionary	Параметры запроса для языка запросов API Intersight.
resource_path string / обязательный	URI настраиваемого ресурса относительно api_uri.
return_list boolean	Если `yes`, в api_response будет возвращён список результатов API. По умолчанию возвращается только первый элемент списка результатов API. Можно использовать только с операциями GET. Варианты: `false` ← (по умолчанию) `true`
state string	Если `present`, будет проверено наличие ресурса, и при необходимости он будет создан. Если `absent`, будет проверено отсутствие ресурса, и при необходимости он будет удалён. Варианты: `"present"` ← (по умолчанию) `"absent"`
update_method string	Метод HTTP, используемый для операций обновления. Для изменения некоторых ресурсов Intersight требуются операции POST. Для частичного обновления используется json-patch. json-patch поддерживается только для операций patch с существующими ресурсами и требует, чтобы list_body был списком словарей. Подробные сведения о JSON Patch см. в документации по API Intersight. Варианты: `"patch"` ← (по умолчанию) `"post"` `"json-patch"`
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, определяющий, проверяется ли сертификат 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_response dictionary	Результат ответа 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_response

dictionary

Результат ответа 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_rest_api_module.html