модуль cisco.meraki.organizations_branding_policies — модуль ресурса для organizations _brandingpolicies

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: cisco.meraki.organizations_branding_policies.

Добавлено в cisco.meraki 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление операциями создания, обновления и удаления ресурса organizations _brandingpolicies.
Добавление новой политики брендинга в организацию.
Удаление политики брендинга.
Обновление политики брендинга.

Примечание

Этому модулю соответствует плагин действий.

Требования

На узле, который выполняет этот модуль, должны быть установлены следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
adminSettings dictionary	Настройки, определяющие, к каким типам администраторов применяется эта политика.
appliesTo string	Типы администраторов, к которым применяется эта политика. Возможные значения: ‘All organization admins’, ‘All enterprise admins’, ‘All network admins’, ‘All admins of networks…’, ‘All admins of networks tagged…’, ‘Specific admins…’, ‘All admins’ или ‘All SAML admins’.
values list / elements=string	Если для ‘appliesTo’ задано одно из значений ‘Specific admins…’, ‘All admins of networks…’ или ‘All admins of networks tagged…’, необходимо указать свойство ‘values’, чтобы задать набор объектов, к которым применяется политика брендинга. Для ‘Specific admins…’ укажите массив идентификаторов администраторов. Для ‘All admins of networks…’ укажите массив идентификаторов сетей и/или шаблонов конфигурации. Для ‘All admins of networks tagged…’ укажите массив имен тегов.
brandingPolicyId string	Параметр пути BrandingPolicyId. Идентификатор политики брендинга.
customLogo dictionary	Свойства, описывающие пользовательский логотип, связанный с политикой брендинга.
enabled boolean	Включен ли пользовательский логотип. Варианты: `false` `true`
image dictionary	Свойства для настройки изображения.
contents string	Содержимое файла (строка в кодировке base64) нового логотипа.
format string	Формат закодированного содержимого. Поддерживаются форматы ‘png’, ‘gif’ и ‘jpg’.
enabled boolean	Логическое значение, указывающее, включена ли эта политика. Варианты: `false` `true`
helpSettings dictionary	Настройки, определяющие изменения различных функций страницы справки. Для каждого свойства этого объекта можно указать одно из значений ‘default or inherit’ (не изменять функциональность), ‘hide’ (удалить раздел из панели управления) или ‘show’ (всегда показывать раздел на панели управления). Некоторые свойства этого объекта также принимают пользовательский HTML-код, заменяющий раздел на панели управления; допустимые значения см. в описании соответствующего свойства. Если значение не указано, для каждого свойства используется ‘default or inherit’.
apiDocsSubtab string	Вкладка «Справка → Документация API», где приведено подробное описание API панели управления. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
casesSubtab string	Вкладка «Справка → Обращения» на панели управления, где можно управлять обращениями в службу поддержки Cisco Meraki для этой организации. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
ciscoMerakiProductDocumentation string	Раздел «Руководства по продуктам» во вкладке «Справка → Получить помощь». Возможные значения: ‘default or inherit’, ‘hide’, ‘show’ или заменяющая пользовательская HTML-строка.
communitySubtab string	Вкладка «Справка → Сообщество», содержащая ссылку на сообщество Meraki. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
dataProtectionRequestsSubtab string	Вкладка «Справка → Запросы на защиту данных» на панели управления, где можно проверять запросы на удаление, ограничение обработки или экспорт данных конечных пользователей. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
firewallInfoSubtab string	Вкладка «Справка → Сведения о брандмауэре», где перечислены необходимые правила межсетевого экрана для связи с облаком Cisco Meraki. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
getHelpSubtab string	Вкладка «Справка → Получить помощь», где отображаются база знаний Cisco Meraki, руководства по продуктам и сведения о поддержке и обращениях. Обратите внимание: если эта вкладка скрыта, настройки брендинга базы знаний в разделе «Получить помощь», документации по продуктам Cisco Meraki и контактных данных службы поддержки не будут видны. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
getHelpSubtabKnowledgeBaseSearch string	Поле поиска по базе знаний, отображаемое на странице справки. Возможные значения: ‘default or inherit’, ‘hide’, ‘show’ или заменяющая пользовательская HTML-строка.
hardwareReplacementsSubtab string	Вкладка «Справка → Сведения о замене», где приведена важная информация о замене устройств. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
helpTab string	Вкладка «Справка», содержащая все сведения о поддержке. Если эта вкладка скрыта, остальные настройки брендинга раздела «Справка» будут недоступны. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
helpWidget string	Виджет справки — это виджет поддержки, предоставляющий доступ к чату, ссылкам на документацию, контактным данным отдела продаж и другим способам связи со службой поддержки Meraki. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
newFeaturesSubtab string	Вкладка «Справка → Новые функции», где описаны новые функции панели управления. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
smForums string	Вкладка «Форумы SM» со ссылкой на поддержку сообщества для Cisco Meraki Systems Manager. Настраивается только для организаций, в которых есть сети Systems Manager. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
supportContactInfo string	Раздел «Связаться со службой поддержки Meraki» во вкладке «Справка → Получить помощь». Возможные значения: ‘default or inherit’, ‘hide’, ‘show’ или заменяющая пользовательская HTML-строка.
universalSearchKnowledgeBaseSearch string	В поле универсального поиска, постоянно отображаемом на панели управления, по умолчанию показываются результаты из базы знаний Meraki. Этот параметр определяет, будут ли отображаться результаты из базы знаний Meraki. Возможные значения: ‘default or inherit’, ‘hide’ или ‘show’.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором пакета действий при ошибке параллельного выполнения По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; его также можно задать в переменной окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL для всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; его также можно задать в переменной окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать экземпляр вашего собственного регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), к имени файла журнала добавляются дата и временная метка По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для вывода журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при получении ответов 429 или других ошибок сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой после ошибки Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при получении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой после другой ошибки 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все журналы? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
name string	Имя политики брендинга панели управления.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

Используемые методы 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 Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для organizations createOrganizationBrandingPolicy: Полное описание API createOrganizationBrandingPolicy.
Документация Cisco Meraki для organizations deleteOrganizationBrandingPolicy: Полное описание API deleteOrganizationBrandingPolicy.
Документация Cisco Meraki для organizations updateOrganizationBrandingPolicy: Полное описание API updateOrganizationBrandingPolicy.

Примеры

- 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_caller: "{{ meraki_caller }}"
    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: 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_caller: "{{ meraki_caller }}"
    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: 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_caller: "{{ meraki_caller }}"
    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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"adminSettings": {"appliesTo": "string", "values": ["string"]}, "customLogo": {"enabled": true, "image": {"preview": {"expiresAt": "string", "url": "string"}}}, "enabled": true, "helpSettings": {"apiDocsSubtab": "string", "casesSubtab": "string", "ciscoMerakiProductDocumentation": "string", "communitySubtab": "string", "dataProtectionRequestsSubtab": "string", "firewallInfoSubtab": "string", "getHelpSubtab": "string", "getHelpSubtabKnowledgeBaseSearch": "string", "hardwareReplacementsSubtab": "string", "helpTab": "string", "helpWidget": "string", "newFeaturesSubtab": "string", "smForums": "string", "supportContactInfo": "string", "universalSearchKnowledgeBaseSearch": "string"}, "name": "string"}

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"adminSettings": {"appliesTo": "string", "values": ["string"]}, "customLogo": {"enabled": true, "image": {"preview": {"expiresAt": "string", "url": "string"}}}, "enabled": true, "helpSettings": {"apiDocsSubtab": "string", "casesSubtab": "string", "ciscoMerakiProductDocumentation": "string", "communitySubtab": "string", "dataProtectionRequestsSubtab": "string", "firewallInfoSubtab": "string", "getHelpSubtab": "string", "getHelpSubtabKnowledgeBaseSearch": "string", "hardwareReplacementsSubtab": "string", "helpTab": "string", "helpWidget": "string", "newFeaturesSubtab": "string", "smForums": "string", "supportContactInfo": "string", "universalSearchKnowledgeBaseSearch": "string"}, "name": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/organizations_branding_policies_module.html