Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_adaptive_policy_acls — модуль ресурса для organizations _adaptivepolicy _acls

Примечание

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

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

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

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

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

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

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

  • Управление операциями создания, обновления и удаления ресурса organizations _adaptivepolicy _acls.
  • Создает новый ACL адаптивной политики.
  • Удаляет указанный ACL адаптивной политики. Обратите внимание: этот ACL адаптивной политики также будет удален из использующих его политик.
  • Обновляет ACL адаптивной политики.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

aclId

string

Параметр пути AclId. Идентификатор ACL.

description

string

Описание ACL адаптивной политики.

ipVersion

string

Версия IP для ACL адаптивной политики. Допустимые значения: ‘any’, ‘ipv4’ или ‘ipv6’.

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

Имя ACL адаптивной политики.

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

rules

list / elements=dictionary

Упорядоченный массив правил ACL адаптивной политики.

dstPort

string

Порт назначения. Должен быть указан в формате одного порта ‘1’, списка портов ‘1,2’ или диапазона портов ‘1-10’; допустимый диапазон значений — от 1 до 65535 или ‘any’. Значение по умолчанию — ‘any’.

log

boolean

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

Допустимые значения:

  • false
  • true

policy

string

Разрешить (‘allow’) или запретить (‘deny’) трафик, указанный этим правилом.

protocol

string

Тип протокола (допустимые значения: ‘tcp’, ‘udp’, ‘icmp’ или ‘any’).

srcPort

string

Порт источника. Должен быть указан в формате одного порта ‘1’, списка портов ‘1,2’ или диапазона портов ‘1-10’; допустимый диапазон значений — от 1 до 65535 или ‘any’. Значение по умолчанию — ‘any’.

tcpEstablished

boolean

Если параметр включен, TCP-соединение с этим узлом должно быть установлено.

Допустимые значения:

  • false
  • true

Примечания

Примечание

  • Используются методы SDK: organizations.Organizations.create_organization_adaptive_policy_acl, organizations.Organizations.delete_organization_adaptive_policy_acl, organizations.Organizations.update_organization_adaptive_policy_acl,
  • Используются пути: post /organizations/{organizationId}/adaptivePolicy/acls, delete /organizations/{organizationId}/adaptivePolicy/acls/{aclId}, put /organizations/{organizationId}/adaptivePolicy/acls/{aclId},
  • Не поддерживает check_mode
  • Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
  • из Cisco Dashboard API Python(SDK)
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

См. также

Документация Cisco Meraki по методу organizations createOrganizationAdaptivePolicyAcl

Полное описание API createOrganizationAdaptivePolicyAcl.

Документация Cisco Meraki по методу organizations deleteOrganizationAdaptivePolicyAcl

Полное описание API deleteOrganizationAdaptivePolicyAcl.

Документация Cisco Meraki по методу organizations updateOrganizationAdaptivePolicyAcl

Полное описание API updateOrganizationAdaptivePolicyAcl.

Примеры

- name: Create
  cisco.meraki.organizations_adaptive_policy_acls:
    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: Blocks sensitive web traffic
    ipVersion: ipv6
    name: Block sensitive web traffic
    organizationId: string
    rules:
      - dstPort: 22-30
        log: true
        policy: deny
        protocol: tcp
        srcPort: 1,33
        tcpEstablished: true
- name: Update by id
  cisco.meraki.organizations_adaptive_policy_acls:
    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
    aclId: string
    description: Blocks sensitive web traffic
    ipVersion: ipv6
    name: Block sensitive web traffic
    organizationId: string
    rules:
      - dstPort: 22-30
        log: true
        policy: deny
        protocol: tcp
        srcPort: 1,33
        tcpEstablished: true
- name: Delete by id
  cisco.meraki.organizations_adaptive_policy_acls:
    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
    aclId: string
    organizationId: string

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"aclId": "string", "createdAt": "string", "description": "string", "ipVersion": "string", "name": "string", "rules": [{"dstPort": "string", "log": true, "policy": "string", "protocol": "string", "srcPort": "string", "tcpEstablished": true}], "updatedAt": "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_adaptive_policy_acls_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API