Try SpotterResource module for organizations _brandingpolicies
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operations create, update and delete of the resource organizations _brandingpolicies.
Add a new branding policy to an organization.
Delete a branding policy.
Update a branding policy.
- 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
name:
description: Name of the Dashboard branding policy.
type: str
enabled:
description: Boolean indicating whether this policy is enabled.
type: bool
customLogo:
description: Properties describing the custom logo attached to the branding policy.
suboptions:
enabled:
description: Whether or not there is a custom logo enabled.
type: bool
image:
description: Properties for setting the image.
suboptions:
contents:
description: The file contents (a base 64 encoded string) of your new logo.
type: str
format:
description: The format of the encoded contents. Supported formats are 'png',
'gif', and jpg'.
type: str
type: dict
type: dict
helpSettings:
description: Settings for describing the modifications to various Help page features.
Each property in this object accepts one of 'default or inherit' (do not modify
functionality), 'hide' (remove the section from Dashboard), or 'show' (always show
the section on Dashboard). Some properties in this object also accept custom HTML
used to replace the section on Dashboard; see the documentation for each property
to see the allowed values. Each property defaults to 'default or inherit' when not
provided.
suboptions:
apiDocsSubtab:
description: The 'Help -> API docs' subtab where a detailed description of the
Dashboard API is listed. Can be one of 'default or inherit', 'hide' or 'show'.
type: str
casesSubtab:
description: The 'Help -> Cases' Dashboard subtab on which Cisco Meraki support
cases for this organization can be managed. Can be one of 'default or inherit',
'hide' or 'show'.
type: str
ciscoMerakiProductDocumentation:
description: The 'Product Manuals' section of the 'Help -> Get Help' subtab. Can
be one of 'default or inherit', 'hide', 'show', or a replacement custom HTML
string.
type: str
communitySubtab:
description: The 'Help -> Community' subtab which provides a link to Meraki Community.
Can be one of 'default or inherit', 'hide' or 'show'.
type: str
dataProtectionRequestsSubtab:
description: The 'Help -> Data protection requests' Dashboard subtab on which
requests to delete, restrict, or export end-user data can be audited. Can be
one of 'default or inherit', 'hide' or 'show'.
type: str
firewallInfoSubtab:
description: The 'Help -> Firewall info' subtab where necessary upstream firewall
rules for communication to the Cisco Meraki cloud are listed. Can be one of
'default or inherit', 'hide' or 'show'.
type: str
getHelpSubtab:
description: The 'Help -> Get Help' subtab on which Cisco Meraki KB, Product Manuals,
and Support/Case Information are displayed. Note that if this subtab is hidden,
branding customizations for the KB on 'Get help', Cisco Meraki product documentation,
and support contact info will not be visible. Can be one of 'default or inherit',
'hide' or 'show'.
type: str
getHelpSubtabKnowledgeBaseSearch:
description: The KB search box which appears on the Help page. Can be one of 'default
or inherit', 'hide', 'show', or a replacement custom HTML string.
type: str
hardwareReplacementsSubtab:
description: The 'Help -> Replacement info' subtab where important information
regarding device replacements is detailed. Can be one of 'default or inherit',
'hide' or 'show'.
type: str
helpTab:
description: The Help tab, under which all support information resides. If this
tab is hidden, no other 'Help' branding customizations will be visible. Can
be one of 'default or inherit', 'hide' or 'show'.
type: str
helpWidget:
description: The 'Help Widget' is a support widget which provides access to live
chat, documentation links, Sales contact info, and other contact avenues to
reach Meraki Support. Can be one of 'default or inherit', 'hide' or 'show'.
type: str
newFeaturesSubtab:
description: The 'Help -> New features' subtab where new Dashboard features are
detailed. Can be one of 'default or inherit', 'hide' or 'show'.
type: str
smForums:
description: The 'SM Forums' subtab which links to community-based support for
Cisco Meraki Systems Manager. Only configurable for organizations that contain
Systems Manager networks. Can be one of 'default or inherit', 'hide' or 'show'.
type: str
supportContactInfo:
description: The 'Contact Meraki Support' section of the 'Help -> Get Help' subtab.
Can be one of 'default or inherit', 'hide', 'show', or a replacement custom
HTML string.
type: str
universalSearchKnowledgeBaseSearch:
description: The universal search box always visible on Dashboard will, by default,
present results from the Meraki KB. This configures whether these Meraki KB
results should be returned. Can be one of 'default or inherit', 'hide' or 'show'.
type: str
type: dict
adminSettings:
description: Settings for describing which kinds of admins this policy applies to.
suboptions:
appliesTo:
description: Which kinds of admins this policy applies to. Can be one of 'All
organization admins', 'All enterprise admins', 'All network admins', 'All admins
of networks...', 'All admins of networks tagged...', 'Specific admins...', 'All
admins' or 'All SAML admins'.
type: str
values:
description: If 'appliesTo' is set to one of 'Specific admins...', 'All admins
of networks...' or 'All admins of networks tagged...', then you must specify
this 'values' property to provide the set of entities to apply the branding
policy to. For 'Specific admins...', specify an array of admin IDs. For 'All
admins of networks...', specify an array of network IDs and/or configuration
template IDs. For 'All admins of networks tagged...', specify an array of tag
names.
elements: str
type: list
type: dict
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
organizationId:
description: OrganizationId path parameter. Organization ID.
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
brandingPolicyId:
description: BrandingPolicyId path parameter. Branding policy ID.
type: str
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"adminSettings\": {\n \"appliesTo\": \"string\",\n \"values\"\
: [\n \"string\"\n ]\n },\n \"customLogo\": {\n \"enabled\": true,\n\
\ \"image\": {\n \"preview\": {\n \"expiresAt\": \"string\",\n\
\ \"url\": \"string\"\n }\n }\n },\n \"enabled\": true,\n \"\
helpSettings\": {\n \"apiDocsSubtab\": \"string\",\n \"casesSubtab\": \"\
string\",\n \"ciscoMerakiProductDocumentation\": \"string\",\n \"communitySubtab\"\
: \"string\",\n \"dataProtectionRequestsSubtab\": \"string\",\n \"firewallInfoSubtab\"\
: \"string\",\n \"getHelpSubtab\": \"string\",\n \"getHelpSubtabKnowledgeBaseSearch\"\
: \"string\",\n \"hardwareReplacementsSubtab\": \"string\",\n \"helpTab\"\
: \"string\",\n \"helpWidget\": \"string\",\n \"newFeaturesSubtab\": \"\
string\",\n \"smForums\": \"string\",\n \"supportContactInfo\": \"string\"\
,\n \"universalSearchKnowledgeBaseSearch\": \"string\"\n },\n \"name\": \"\
string\"\n}\n"
type: dict