cisco.meraki.organizations_adaptive_policy_groups_info 模块 – 组织 _adaptivepolicy _groups 的信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.meraki
。您需要进一步的要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定:cisco.meraki.organizations_adaptive_policy_groups_info
。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有组织的 _adaptivepolicy _groups。
按 id 获取组织 _adaptivepolicy _groups。
列出组织中的自适应策略组。
返回一个自适应策略组。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
其他标头。 |
|
Id 路径参数。 |
|
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 方法是 organizations.Organizations.get_organization_adaptive_policy_group, organizations.Organizations.get_organization_adaptive_policy_groups,
使用的路径是 get /organizations/{organizationId}/adaptivePolicy/groups, get /organizations/{organizationId}/adaptivePolicy/groups/{id},
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 文档,关于 organizations getOrganizationAdaptivePolicyGroup
getOrganizationAdaptivePolicyGroup API 的完整参考。
- Cisco Meraki 文档,关于 organizations getOrganizationAdaptivePolicyGroups
getOrganizationAdaptivePolicyGroups API 的完整参考。
示例
- name: Get all organizations _adaptivepolicy _groups
cisco.meraki.organizations_adaptive_policy_groups_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
- name: Get organizations _adaptivepolicy _groups by id
cisco.meraki.organizations_adaptive_policy_groups_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
id: string
register: result
返回值
常见返回值已记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典或列表,包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |