Модуль cisco.meraki.devices_cellular_sims — модуль ресурсов для devices _cellular _sims
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты. Подробную информацию см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.devices_cellular_sims.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление операцией обновления ресурса devices _cellular _sims.
- Обновляет конфигурации SIM-карт и APN для сотового устройства.
Примечание
Этому модулю соответствует плагин действия.
Требования
На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), ключ API, созданный в панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: |
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), наследовать собственный экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), к имени файла журнала добавляются дата и временная метка По умолчанию: |
meraki_log_path string | log_path (string), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создавать файл журнала вывода? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное время выполнения каждого вызова API в секундах По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить ведение журналов? Тогда вы действуете на свой страх и риск! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять попытку при достижении ограничения частоты запросов с ошибкой 429? Варианты:
|
serial string | Параметр пути serial. |
simFailover dictionary | Параметры переключения SIM-карты. |
|
enabled boolean |
Переключение на вторичную SIM-карту (необязательно). Варианты:
|
|
timeout integer |
Тайм-аут переключения в секундах (необязательно). |
simOrdering list / элементы=string | Задаёт порядок всех SIM-карт для MG: основная, вторичная и неиспользуемая (если применимо). Этот параметр обязателен для устройств с тремя и более SIM-картами и может использоваться вместо ‘isPrimary’ для устройств с двумя SIM-картами. Чтобы указать eSIM, используйте ‘sim3’. Переключение SIM-карт происходит только между слотами основной и вторичной SIM-карты. |
sims list / элементы=dictionary | Список SIM-карт. Если SIM-карта была настроена ранее и не указана в этом запросе, её конфигурация останется без изменений. |
|
apns list / элементы=dictionary |
Конфигурации APN. Если список пуст, будет использоваться APN по умолчанию. |
|
allowedIpTypes list / элементы=string |
Поддерживаемые версии IP (допустимые значения: ‘ipv4’, ‘ipv6’). |
|
authentication dictionary |
Параметры аутентификации APN. |
|
password string |
Пароль APN, если задан тип (если пароль APN не указан, он останется без изменений). |
|
type string |
Тип аутентификации APN. |
|
username string |
Имя пользователя APN, если задан тип. |
|
name string |
Имя APN. |
|
isPrimary boolean |
Если значение равно true, эта SIM-карта активируется при загрузке платформы. Для устройств с одной SIM-картой значение должно быть true. Это обязательное поле для MG с двумя SIM-картами, если конфигурация не задаётся с помощью ‘simOrdering’. Варианты:
|
|
simOrder integer |
Приоритет настраиваемого слота SIM-карты. Используйте значение от 1 до общего количества доступных SIM-карт. Значение должно быть уникальным для каждой SIM-карты. |
|
slot string |
Настраиваемый слот SIM-карты. На устройствах с одной SIM-картой должен иметь значение ‘sim1’. Для eSIM используйте ‘sim3’. |
Примечания
Примечание
- Используемый метод SDK: devices.Devices.update_device_cellular_sims,
- Используемые пути: put /devices/{serial}/cellular/sims,
- Не поддерживает
check_mode - Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений
- из Cisco Dashboard API Python(SDK)
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco Meraki по devices updateDeviceCellularSims
-
Полное описание API updateDeviceCellularSims.
Примеры
- name: Update all
cisco.meraki.devices_cellular_sims:
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 }}"
state: present
serial: string
simFailover:
enabled: true
timeout: 300
simOrdering:
- sim1
- sim2
- sim3
sims:
- apns:
- allowedIpTypes:
- ipv4
- ipv6
authentication:
password: secret
type: pap
username: milesmeraki
name: internet
isPrimary: false
simOrder: 3
slot: sim1
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response dictionary | Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/devices_cellular_sims_module.html