Модуль cisco.meraki.organizations_sm_sentry_policies_assignments — Модуль ресурсов для организаций _sm _sentry _policies _assignments

Примечание

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

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

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

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

Новое в cisco.meraki 2.18.0

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

Описание

Управление обновлением операции ресурса organizations _sm _sentry _policies _assignments.
Обновление политик Sentry организации с помощью предоставленного списка. Политики Sentry упорядочены в порядке убывания приоритета (т.е. наивысший приоритет внизу), что противоположно пользовательскому интерфейсу панели управления. Политики, отсутствующие в запросе, будут удалены.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
items список / элементы=словарь	Политики Sentry Group для организации, проиндексированные по идентификатору сети.
networkId строка	Идентификатор сети.
policies список / элементы=словарь	Массив политик Sentry Group для сети.
groupPolicyId строка	Идентификатор политики группы.
policyId строка	Идентификатор Sentry Policy, если обновляется существующая Sentry Policy.
scope строка	Область применения Sentry Policy.
smNetworkId строка	Идентификатор сети Systems Manager.
tags список / элементы=строка	Теги для Sentry Policy.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки ошибки пакетной обработки действий По умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), ключ API, сгенерированный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config логический тип	meraki_inherit_logging_config (логический тип), наследует собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла лога, дополненное датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода логов; по умолчанию, рабочая директория скрипта, если не указано По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), количество повторных попыток при столкновении с 429 или другими ошибками со стороны сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log логический тип	meraki_output_log (логический тип), создать файл лога вывода? Варианты: `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` ← (по умолчанию)
organizationId string	Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

Используемый метод SDK: sm.Sm.update_organization_sm_sentry_policies_assignments,
Используемые пути: put /organizations/{organizationId}/sm/sentry/policies/assignments,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по sm updateOrganizationSmSentryPoliciesAssignments: Полное описание API updateOrganizationSmSentryPoliciesAssignments.

Примеры

- name: Update all
  cisco.meraki.organizations_sm_sentry_policies_assignments:
    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}}"
    items:
    - networkId: N_24329156
      policies:
      - groupPolicyId: '1284392014819'
        policyId: '1284392014819'
        scope: withAny
        smNetworkId: N_24329156
        tags:
        - tag1
        - tag2
    organizationId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"items": [{"networkId": "string", "policies": [{"createdAt": "string", "groupNumber": "string", "groupPolicyId": "string", "lastUpdatedAt": "string", "networkId": "string", "policyId": "string", "priority": "string", "scope": "string", "smNetworkId": "string", "tags": ["string"]}]}]}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"items": [{"networkId": "string", "policies": [{"createdAt": "string", "groupNumber": "string", "groupPolicyId": "string", "lastUpdatedAt": "string", "networkId": "string", "policyId": "string", "priority": "string", "scope": "string", "smNetworkId": "string", "tags": ["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_sm_sentry_policies_assignments_module.html