cisco.meraki.organizations_adaptive_policy_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。
cisco.meraki 2.16.0 中的新功能
概要
- 管理资源 organizations _adaptivepolicy _groups 的创建、更新和删除操作。 
- 创建新的自适应策略组。 
- 删除指定的自适应策略组以及任何关联的策略和引用。 
- 更新自适应策略组。如果更新“基础设施”,则只允许 SGT。不能更新“未知”。 
注意
此模块具有相应的操作插件。
要求
执行此模块的主机上需要以下要求。
- 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 (布尔值), 继承您自己的 logger 实例 选项 
 | |
| 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。 | |
| 属于此组的策略对象;如果未在使用其他标记方案,则来自这些策略对象指定的地址的流量将使用此组的 SGT 值进行标记(每个都需要一个唯一的属性)()。 | |
| 策略对象的 ID。 | |
| 策略对象的名称。 | |
| 组的 SGT 值。 | 
注释
注意
- 使用的 SDK 方法是 organizations.Organizations.create_organization_adaptive_policy_group、organizations.Organizations.delete_organization_adaptive_policy_group、organizations.Organizations.update_organization_adaptive_policy_group, 
- 使用的路径是 post /organizations/{organizationId}/adaptivePolicy/groups、delete /organizations/{organizationId}/adaptivePolicy/groups/{id}、put /organizations/{organizationId}/adaptivePolicy/groups/{id}, 
- 不支持 - check_mode
- 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器 
- 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接 
另请参阅
另请参阅
- 思科 Meraki 文档,用于组织创建组织自适应策略组
- createOrganizationAdaptivePolicyGroup API 的完整参考。 
- 思科 Meraki 文档,用于组织删除组织自适应策略组
- deleteOrganizationAdaptivePolicyGroup API 的完整参考。 
- 思科 Meraki 文档,用于组织更新组织自适应策略组
- updateOrganizationAdaptivePolicyGroup API 的完整参考。 
示例
- name: Create
  cisco.meraki.organizations_adaptive_policy_groups:
    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
    description: Group of XYZ Corp Employees
    isDefaultGroup: false
    name: Employee Group
    organizationId: string
    policyObjects:
    - id: '2345'
      name: Example Policy Object
    requiredIpMappings: []
    sgt: 1000
- name: Delete by id
  cisco.meraki.organizations_adaptive_policy_groups:
    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: absent
    id: string
    organizationId: string
- name: Update by id
  cisco.meraki.organizations_adaptive_policy_groups:
    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
    description: Group of XYZ Corp Employees
    id: string
    isDefaultGroup: false
    name: Employee Group
    organizationId: string
    policyObjects:
    - id: '2345'
      name: Example Policy Object
    requiredIpMappings: []
    sgt: 1000
返回值
常用返回值已在此处记录 此处,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 一个字典或列表,包含思科 Meraki Python SDK 返回的响应 返回: 总是 示例:  | 
