Модуль cisco.meraki.organizations_licensing_coterm_licenses_move — Модуль ресурсов для перемещения лицензий coterm организаций

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: cisco.meraki.organizations_licensing_coterm_licenses_move.

Новое в cisco.meraki 2.16.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Управляет операцией создания ресурса организации _licensing _coterm _licenses _move.
Перемещает лицензию в другую организацию coterm только.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
destination словарь	Данные назначения для перемещения лицензии.
mode строка	Режим присвоения перемещаемой лицензии.
organizationId строка	Организация, в которую нужно переместить лицензию.
licenses список / элементы=словарь	Список лицензий, которые нужно переместить.
counts список / элементы=словарь	Количество лицензий для перемещения по типу модели.
count целое число	Количество лицензий для перемещения.
model строка	Тип модели лицензии, для которой нужно переместить количество.
key строка	Ключ лицензии, из которого нужно переместить количество.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания при повторном выполнении задачи пакетной обработки действий Значение по умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), API ключ, сгенерированный на панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), префикс для всех ресурсов конечной точки Значение по умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID Значение по умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER Значение по умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси Значение по умолчанию: `""`
meraki_inherit_logging_config логический	meraki_inherit_logging_config (логический), Наследует ваш собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла логов, дополненное датой и временем Значение по умолчанию: `"meraki_api_"`
meraki_log_path строка	путь_к_логу (строка), путь для вывода логов; по умолчанию, рабочая директория скрипта, если не указано Значение по умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), количество попыток повторного выполнения при возникновении ошибок 429 или других ошибок на стороне сервера Значение по умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания при повторном выполнении при ошибке Nginx 429 Значение по умолчанию: `60`
meraki_output_log логический	meraki_output_log (логический), создать файл логов вывода? Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

meraki_print_console boolean	meraki_print_console (boolean), выводить ли логирование в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при обнаружении ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания при повторной попытке ошибки 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE для предотвращения изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить всю регистрацию? Тогда на вас лежит вся ответственность! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку при обнаружении ошибки 429 ограничения скорости? Варианты: `false` `true` ← (по умолчанию)
organizationId string	Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

Используемый метод SDK — licensing.Licensing.move_organization_licensing_coterm_licenses,
Используемые пути — post /organizations/{organizationId}/licensing/coterm/licenses/move,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины соединения Ansible, а вместо этого использует встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для licensing moveOrganizationLicensingCotermLicenses: Полное описание API moveOrganizationLicensingCotermLicenses.

Примеры

- name: Create
  cisco.meraki.organizations_licensing_coterm_licenses_move:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    destination:
      mode: addDevices
      organizationId: '123'
    licenses:
    - counts:
      - count: 5
        model: MR Enterprise
      key: Z2AA-BBBB-CCCC
    organizationId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"movedLicenses": [{"claimedAt": "string", "counts": [{"count": 0, "model": "string"}], "duration": 0, "editions": [{"edition": "string", "productType": "string"}], "expired": true, "invalidated": true, "invalidatedAt": "string", "key": "string", "mode": "string", "organizationId": "string", "startedAt": "string"}], "remainderLicenses": [{"claimedAt": "string", "counts": [{"count": 0, "model": "string"}], "duration": 0, "editions": [{"edition": "string", "productType": "string"}], "expired": true, "invalidated": true, "invalidatedAt": "string", "key": "string", "mode": "string", "organizationId": "string", "startedAt": "string"}]}

Ключ

Описание

meraki_response

словарь

Словарь или список со значением, возвращённым Cisco Meraki Python SDK

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

Пример: {"movedLicenses": [{"claimedAt": "string", "counts": [{"count": 0, "model": "string"}], "duration": 0, "editions": [{"edition": "string", "productType": "string"}], "expired": true, "invalidated": true, "invalidatedAt": "string", "key": "string", "mode": "string", "organizationId": "string", "startedAt": "string"}], "remainderLicenses": [{"claimedAt": "string", "counts": [{"count": 0, "model": "string"}], "duration": 0, "editions": [{"edition": "string", "productType": "string"}], "expired": true, "invalidated": true, "invalidatedAt": "string", "key": "string", "mode": "string", "organizationId": "string", "startedAt": "string"}]}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекции

© 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/meraki/organizations_licensing_coterm_licenses_move_module.html