Модуль cisco.meraki.organizations_adaptive_policy_groups — модуль ресурсов для organizations _adaptivepolicy _groups
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: cisco.meraki.organizations_adaptive_policy_groups.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление созданием, обновлением и удалением ресурса organizations _adaptivepolicy _groups.
- Создаёт новую группу адаптивной политики.
- Удаляет указанную группу адаптивной политики, а также все связанные политики и ссылки.
- Обновляет группу адаптивной политики. При обновлении «Infrastructure» разрешено изменять только SGT. Обновление «Unknown» невозможно.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, на котором выполняется этот модуль, необходимы следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
description string | Описание группы (по умолчанию «»). |
id string | Параметр пути Id. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), API-ключ, созданный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый адрес перед всеми ресурсами конечных точек По умолчанию: |
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), наследовать пользовательский экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем По умолчанию: |
meraki_log_path string | log_path (string), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), максимальное количество повторов при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором после ошибки 429 от Nginx По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создавать ли файл журнала вывода? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить ли журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять ли запрос при получении другой ошибки 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором после другой ошибки 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить ведение всех журналов? В таком случае вы предоставлены сами себе! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять ли запрос при ошибке ограничения частоты запросов 429? Варианты:
|
name string | Имя группы. |
organizationId string | Параметр пути OrganizationId. Идентификатор организации. |
policyObjects list / elements=dictionary | Объекты политики, входящие в эту группу; трафик с адресов, указанных в этих объектах политики, будет помечен значением SGT этой группы, если не используется другая схема тегирования (для каждого объекта требуется один уникальный атрибут) (значение по умолчанию отсутствует). |
|
id string |
Идентификатор объекта политики. |
|
name string |
Имя объекта политики. |
sgt integer | Значение SGT группы. |
Примечания
Примечание
- Используемые методы SDK: organizations.Organizations.create_organization_adaptive_policy_group, organizations.Organizations.delete_organization_adaptive_policy_group, organizations.Organizations.update_organization_adaptive_policy_group,
- Используемые пути: post /organizations/{organizationId}/adaptivePolicy/groups, delete /organizations/{organizationId}/adaptivePolicy/groups/{id}, put /organizations/{organizationId}/adaptivePolicy/groups/{id},
- Не поддерживает
check_mode - Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений
- из Cisco Dashboard API Python(SDK)
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки соединения
См. также
См. также
- Документация Cisco Meraki по методу organizations createOrganizationAdaptivePolicyGroup
-
Полное описание API createOrganizationAdaptivePolicyGroup.
- Документация Cisco Meraki по методу organizations deleteOrganizationAdaptivePolicyGroup
-
Полное описание API deleteOrganizationAdaptivePolicyGroup.
- Документация Cisco Meraki по методу organizations updateOrganizationAdaptivePolicyGroup
-
Полное описание API updateOrganizationAdaptivePolicyGroup.
Примеры
- name: Create
cisco.meraki.organizations_adaptive_policy_groups:
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
description: Group of XYZ Corp Employees
name: Employee Group
organizationId: string
policyObjects:
- id: '2345'
name: Example Policy Object
sgt: 1000
- name: Update by id
cisco.meraki.organizations_adaptive_policy_groups:
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
description: Group of XYZ Corp Employees
id: string
name: Employee Group
organizationId: string
policyObjects:
- id: '2345'
name: Example Policy Object
sgt: 1000
- name: Delete by id
cisco.meraki.organizations_adaptive_policy_groups:
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
id: string
organizationId: string
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response dictionary | Словарь или список с ответом, полученным от Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_adaptive_policy_groups_module.html