Модуль cisco.meraki.organizations_licensing_coterm_licenses_move — модуль ресурса для organizations _licensing _coterm _licenses _move

Примечание

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

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

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

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

Добавлено в cisco.meraki 1.0.0

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

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

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

Примечание

Этому модулю соответствует плагин действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
destination dictionary	Данные о целевом расположении для перемещения лицензии.
mode string	Режим назначения перемещённой лицензии.
organizationId string	Организация, в которую нужно переместить лицензию.
licenses list / elements=dictionary	Список лицензий для перемещения.
counts list / elements=dictionary	Количество лицензий для перемещения, сгруппированное по типу модели.
count integer	Количество лицензий для перемещения.
model string	Тип модели лицензии, для которой нужно переместить количество лицензий.
key string	Ключ лицензии, из которой нужно переместить количество лицензий.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором пакетного действия при ошибке параллельного выполнения По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), API-ключ, созданный в панели управления; его также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; его также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать экземпляр вашего регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для записи журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке 429 от Nginx По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
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 Dashboard API Python(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_caller: "{{ meraki_caller }}"
    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 dictionary	Словарь или список с ответом, возвращённым 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

dictionary

Словарь или список с ответом, возвращённым 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/organizations_licensing_coterm_licenses_move_module.html