cisco.meraki.devices_cellular_sims 模块 – 设备蜂窝 SIM 卡资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：cisco.meraki.devices_cellular_sims。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 devices_cellular_sims 的操作更新。
更新蜂窝设备的 SIM 卡和 APN 配置。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key (字符串)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串)，所有端点资源的前缀 默认值： |
|
meraki_be_geo_id (字符串)，API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller (字符串)，API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path (字符串)，如果在本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config (布尔值)，继承您自己的日志记录实例 选项
|
|
meraki_log_file_prefix (字符串)，日志文件名后追加日期和时间戳 默认值： |
|
log_path (字符串)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： |
|
meraki_maximum_retries (整数)，遇到 429 或其他服务器端错误时，最多重试这么多次 默认值： |
|
meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认值： |
|
meraki_output_log (布尔值)，创建输出日志文件？ 选项
|
|
meraki_print_console (布尔值)，将日志输出打印到控制台？ 选项
|
|
meraki_requests_proxy (字符串)，如果需要，用于 HTTPS 的代理服务器和端口 默认值： |
|
meraki_retry_4xx_error (布尔值)，如果遇到其他 4XX 错误（除了 429）则重试？ 选项
|
|
meraki_retry_4xx_error_wait_time (整数)，其他 4XX 错误重试等待时间 默认值： |
|
meraki_simulate (布尔值)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项
|
|
meraki_single_request_timeout (整数)，每个 API 调用的最大秒数 默认值： |
|
meraki_suppress_logging (布尔值)，禁用所有日志记录？ 那样的话就只能靠你自己了！ 选项
|
|
meraki_use_iterator_for_get_pages (布尔值)，list* 方法将返回一个包含每个对象的迭代器，而不是包含所有项目的完整列表 选项
|
|
meraki_wait_on_rate_limit (布尔值)，如果遇到 429 速率限制错误则重试？ 选项
|
|
串口路径参数。 |
|
SIM 故障转移设置。 |
|
故障转移到辅助 SIM 卡（可选）。 选项
|
|
故障转移超时时间（秒）（可选）。 |
|
SIM 卡列表。如果先前已配置 SIM 卡并且未在此请求中指定，则它将保持不变。 |
|
APN 配置。如果为空，将使用默认 APN。 |
|
支持的IP版本（允许的值包括“ipv4”、“ipv6”）。 |
|
APN身份验证配置。 |
|
APN密码，如果设置了类型（如果未提供APN密码，则密码保持不变）。 |
|
APN身份验证类型。 |
|
APN用户名，如果设置了类型。 |
|
APN名称。 |
|
如果为真，则此SIM卡用于启动。在单SIM设备上必须为真。 选项
|
|
正在配置的SIM卡插槽。在单SIM设备上必须为“sim1”。 |
备注
注意
使用的SDK方法是devices.Devices.update_device_cellular_sims，
使用的路径是put /devices/{serial}/cellular/sims，
不支持
check_mode该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco DNAC SDK中的嵌入式连接管理器。
以dnac_开头的参数由Cisco DNAC Python SDK用于建立连接。
另请参见
另请参见
- Cisco Meraki文档，用于devices updateDeviceCellularSims
updateDeviceCellularSims API的完整参考。
示例
- 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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
apns:
- allowedIpTypes:
- ipv4
- ipv6
authentication:
password: secret
type: pap
username: milesmeraki
name: internet
isPrimary: true
serial: string
slot: sim1
返回值
常见的返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含Cisco Meraki Python SDK返回的响应的字典或列表。 返回：始终 示例： |