cisco.meraki.organizations_camera_roles_info 模块 – 用于组织摄像机角色的信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install cisco.meraki
。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。
要在playbook中使用它,请指定: cisco.meraki.organizations_camera_roles_info
。
cisco.meraki 2.18.0中的新增功能
概要
获取所有组织的摄像机角色。
列出此组织中的所有角色。
注意
此模块具有相应的 动作插件。
要求
执行此模块的主机需要以下要求。
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速率限制错误则重试? 选项
|
|
OrganizationId 路径参数。组织ID。 |
备注
注意
使用的SDK方法是camera.Camera.get_organization_camera_roles,
使用的路径是get /organizations/{organizationId}/camera/roles,
支持
check_mode
该插件在控制节点上运行,不使用任何Ansible连接插件,而是使用Cisco Meraki SDK中的嵌入式连接管理器
以meraki_开头的参数由Cisco Meraki Python SDK用于建立连接
另请参阅
另请参阅
- Cisco Meraki关于camera getOrganizationCameraRoles的文档
getOrganizationCameraRoles API的完整参考。
示例
- name: Get all organizations _camera _roles
cisco.meraki.organizations_camera_roles_info:
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}}"
organizationId: string
register: result
返回值
公共返回值已记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
包含Cisco Meraki Python SDK返回的响应的字典或列表 已返回:始终 示例: |