cisco.meraki.organizations_branding_policies 模块 – 用于 organizations _brandingpolicies 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参见 要求。
要在 playbook 中使用它，请指定：cisco.meraki.organizations_branding_policies。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 organizations _brandingpolicies 的创建、更新和删除操作。
向组织添加新的品牌策略。
删除品牌策略。
更新品牌策略。
注意
此模块具有相应的 操作插件。
要求
以下是在执行此模块的主机上所需的要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
描述此策略适用于哪些类型管理员的设置。 |
|
此策略适用于哪些类型的管理员。可以是“所有组织管理员”、“所有企业管理员”、“所有网络管理员”、“所有网络管理员”、“所有标记网络的管理员”、“特定管理员…”、“所有管理员”或“所有 SAML 管理员”之一。 |
|
如果将“appliesTo”设置为“特定管理员…”、“所有网络管理员…”或“所有标记网络的管理员…”之一，则必须指定此“values”属性以提供要应用品牌策略的实体集。对于“特定管理员…”，请指定管理员 ID 数组。对于“所有网络管理员…”，请指定网络 ID 和/或配置模板 ID 的数组。对于“所有标记网络的管理员…”，请指定标签名称的数组。 |
|
BrandingPolicyId 路径参数。品牌策略 ID。 |
|
描述附加到品牌策略的自定义徽标的属性。 |
|
是否启用了自定义徽标。 选项
|
|
用于设置图像的属性。 |
|
新徽标的文件内容（Base64 编码的字符串）。 |
|
编码内容的格式。支持的格式为“png”、“gif”和“jpg”。 |
|
指示是否启用此策略的布尔值。 选项
|
|
用于描述对各种“帮助”页面功能进行修改的设置。此对象中的每个属性都接受“默认或继承”（不修改功能）、“隐藏”（从仪表板中删除该部分）或“显示”（始终在仪表板上显示该部分）之一。此对象中的某些属性还接受用于替换仪表板上该部分的自定义 HTML；请参阅每个属性的文档以查看允许的值。当未提供时，每个属性默认为“默认或继承”。 |
|
“帮助 -> API 文档”子选项卡，其中列出了仪表板 API 的详细说明。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 个案”仪表板子选项卡，可以在其中管理此组织的 Cisco Meraki 支持个案。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 获取帮助”子选项卡的“产品手册”部分。可以是“默认或继承”、“隐藏”、“显示”或替换自定义 HTML 字符串之一。 |
|
“帮助 -> 社区”子选项卡，提供指向 Meraki 社区的链接。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 数据保护请求”仪表板子选项卡，可以在其中审核删除、限制或导出最终用户数据的请求。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 防火墙信息”子选项卡，其中列出了与 Cisco Meraki 云通信所需的必要上游防火墙规则。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 获取帮助”子选项卡，其中显示了 Cisco Meraki 知识库、产品手册和支持/个案信息。请注意，如果隐藏此子选项卡，则“获取帮助”中的知识库、Cisco Meraki 产品文档和支持联系信息的品牌自定义将不可见。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助”页面上显示的知识库搜索框。可以是“默认或继承”、“隐藏”、“显示”或替换自定义 HTML 字符串之一。 |
|
“帮助 -> 更换信息”子选项卡，其中详细介绍了有关设备更换的重要信息。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助”选项卡，其中包含所有支持信息。如果隐藏此选项卡，则不会显示任何其他“帮助”品牌自定义。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助小部件”是一个支持小部件，提供对实时聊天、文档链接、销售联系信息以及其他联系 Meraki 支持的方式的访问。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 新功能”子选项卡，其中详细介绍了新的仪表板功能。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“SM 论坛”子选项卡，链接到基于社区的 Cisco Meraki Systems Manager 支持。仅适用于包含 Systems Manager 网络的组织。可以是“默认或继承”、“隐藏”或“显示”之一。 |
|
“帮助 -> 获取帮助”子选项卡的“联系 Meraki 支持”部分。可以是“默认或继承”、“隐藏”、“显示”或替换自定义 HTML 字符串之一。 |
|
仪表板上始终可见的通用搜索框默认情况下会显示 Meraki 知识库的结果。此配置用于确定是否应返回这些 Meraki 知识库结果。 可以是 ‘default 或 inherit’、‘hide’ 或 ‘show’ 中的一个值。 |
|
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.create_organization_branding_policy, organizations.Organizations.delete_organization_branding_policy, organizations.Organizations.update_organization_branding_policy,
使用的路径是 post /organizations/{organizationId}/brandingPolicies, delete /organizations/{organizationId}/brandingPolicies/{brandingPolicyId}, put /organizations/{organizationId}/brandingPolicies/{brandingPolicyId},
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，关于 organizations createOrganizationBrandingPolicy
createOrganizationBrandingPolicy API 的完整参考。
- Cisco Meraki 文档，关于 organizations deleteOrganizationBrandingPolicy
deleteOrganizationBrandingPolicy API 的完整参考。
- Cisco Meraki 文档，关于 organizations updateOrganizationBrandingPolicy
updateOrganizationBrandingPolicy API 的完整参考。
示例
- name: Create
cisco.meraki.organizations_branding_policies:
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
adminSettings:
appliesTo: All admins of networks...
values:
- N_1234
- L_5678
customLogo:
enabled: true
image:
contents: Hyperg26C8F4h8CvcoUqpA==
format: jpg
enabled: true
helpSettings:
apiDocsSubtab: default or inherit
casesSubtab: hide
ciscoMerakiProductDocumentation: show
communitySubtab: show
dataProtectionRequestsSubtab: default or inherit
firewallInfoSubtab: hide
getHelpSubtab: default or inherit
getHelpSubtabKnowledgeBaseSearch: <h1>Some custom HTML content</h1>
hardwareReplacementsSubtab: hide
helpTab: show
helpWidget: hide
newFeaturesSubtab: show
smForums: hide
supportContactInfo: show
universalSearchKnowledgeBaseSearch: hide
name: My Branding Policy
organizationId: string
- name: Delete by id
cisco.meraki.organizations_branding_policies:
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
brandingPolicyId: string
organizationId: string
- name: Update by id
cisco.meraki.organizations_branding_policies:
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
adminSettings:
appliesTo: All admins of networks...
values:
- N_1234
- L_5678
brandingPolicyId: string
customLogo:
enabled: true
image:
contents: Hyperg26C8F4h8CvcoUqpA==
format: jpg
enabled: true
helpSettings:
apiDocsSubtab: default or inherit
casesSubtab: hide
ciscoMerakiProductDocumentation: show
communitySubtab: show
dataProtectionRequestsSubtab: default or inherit
firewallInfoSubtab: hide
getHelpSubtab: default or inherit
getHelpSubtabKnowledgeBaseSearch: <h1>Some custom HTML content</h1>
hardwareReplacementsSubtab: hide
helpTab: show
helpWidget: hide
newFeaturesSubtab: show
smForums: hide
supportContactInfo: show
universalSearchKnowledgeBaseSearch: hide
name: My Branding Policy
organizationId: string
返回值
通用返回值记录在此处：此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |