Модуль cisco.meraki.organizations_branding_policies – Модуль ресурсов для организаций _brandingpolicies

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.organizations_branding_policies.

Новая функция в cisco.meraki 2.16.0

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

Обзор

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

Примечание

Для этого модуля существует соответствующий плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
adminSettings словарь	Настройки, описывающие, к каким типам администраторов применяется данная политика.
appliesTo строка	Какие типы администраторов охватывает данная политика. Может принимать значения: «Все администраторы организации», «Все администраторы предприятия», «Все администраторы сети», «Все администраторы сетей…», «Все администраторы сетей с тегом…», «Конкретные администраторы…», «Все администраторы» или «Все администраторы SAML».
values список / элементы=строка	Если «appliesTo» установлено в «Конкретные администраторы…», «Все администраторы сетей…» или «Все администраторы сетей с тегом…», необходимо указать свойство «values», чтобы предоставить набор сущностей, к которым будет применена политика брендинга. Для «Конкретных администраторов…» укажите массив идентификаторов администраторов. Для «Все администраторы сетей…» укажите массив идентификаторов сетей и/или идентификаторов шаблонов конфигурации. Для «Все администраторы сетей с тегом…» укажите массив названий тегов.
brandingPolicyId строка	Параметр пути brandingPolicyId. Идентификатор политики брендинга.
customLogo словарь	Свойства, описывающие логотип, настроенный для политики брендинга.
enabled булево	Включен ли настраиваемый логотип. Варианты: `false` `true`
image словарь	Свойства для настройки изображения.
contents строка	Содержимое файла (строка в кодировке base64) нового логотипа.
format строка	Формат закодированного содержимого. Поддерживаются форматы «png», «gif» и «jpg».
enabled булево	Булево значение, указывающее, включена ли данная политика. Варианты: `false` `true`
helpSettings словарь	Настройки для описания изменений в различных разделах справки. Каждое свойство в этом объекте принимает одно из значений: «по умолчанию или наследовать» (не изменять функциональность), «скрыть» (удалить раздел из панели управления) или «показать» (всегда показывать раздел на панели управления). Некоторые свойства в этом объекте также принимают пользовательский HTML для замены раздела на панели управления; см. документацию по каждому свойству для просмотра допустимых значений. Каждое свойство по умолчанию устанавливается в «по умолчанию или наследовать», если не указано иное.
apiDocsSubtab строка	Подраздел «Справка —> Документация API», где указано подробное описание API панели управления. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
casesSubtab строка	Подраздел панели управления «Справка —> Случаи», где можно управлять случаями поддержки Cisco Meraki для данной организации. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
ciscoMerakiProductDocumentation строка	Раздел «Руководства по продуктам» в подразделе «Справка —> Получить помощь». Может принимать значения «по умолчанию или наследовать», «скрыть», «показать» или строку пользовательского HTML.
communitySubtab строка	Подраздел «Справка —> Сообщество», предоставляющий ссылку на сообщество Meraki. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
dataProtectionRequestsSubtab строка	Подраздел панели управления «Справка —> Запросы защиты данных», в котором можно просмотреть запросы на удаление, ограничение или экспорт данных конечных пользователей. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
firewallInfoSubtab строка	Подраздел «Справка —> Информация о брандмауэре», где перечислены необходимые правила брандмауэра для связи с облаком Cisco Meraki. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
getHelpSubtab строка	Подраздел «Справка —> Получить помощь», на котором отображаются база знаний Cisco Meraki, руководства по продуктам и информация о поддержке/случаях. Обратите внимание, что если этот подраздел скрыт, персонализированные бренды для базы знаний в разделе «Получить помощь», документации по продуктам Cisco Meraki и контактов службы поддержки не будут отображаться. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».
getHelpSubtabKnowledgeBaseSearch строка	Поле поиска БД, которое появляется на странице справки. Может принимать значения «по умолчанию или наследовать», «скрыть», «показать» или строку пользовательского HTML.
hardwareReplacementsSubtab строка	Подраздел «Справка —> Информация о замене», где подробно описывается важная информация о замене устройств. Может принимать значения «по умолчанию или наследовать», «скрыть» или «показать».

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), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иначе Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)

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 DNAC 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_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

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/organizations_branding_policies_module.html