Модуль cisco.meraki.networks_vlan_profiles — модуль ресурсов для networks _vlanprofiles
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для работы с этим модулем требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_vlan_profiles.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление операциями создания, обновления и удаления ресурса networks _vlanprofiles.
- Создание профиля VLAN для сети.
- Удаление профиля VLAN сети.
- Обновление существующего профиля VLAN сети.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
iname string | Имя профиля. |
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), базовый URL для всех ресурсов конечных точек По умолчанию: |
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), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: |
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 | Имя профиля; длина строки должна составлять от 1 до 255 символов. |
networkId string | Параметр пути NetworkId. Идентификатор сети. |
vlanGroups list / элементы=dictionary | Массив групп VLAN. |
|
name string |
Имя VLAN; длина строки должна составлять от 1 до 32 символов. |
|
vlanIds string |
Идентификаторы VLAN или диапазоны идентификаторов, разделённые запятыми. |
vlanNames list / элементы=dictionary | Массив именованных VLAN. |
|
adaptivePolicyGroup dictionary |
Группа адаптивной политики, назначенная идентификатору VLAN. |
|
id string |
Идентификатор группы адаптивной политики. |
|
name string |
Имя VLAN; длина строки должна составлять от 1 до 32 символов. |
|
vlanId string |
Идентификатор VLAN. |
Примечания
Примечание
- Используемые методы SDK: networks.Networks.create_network_vlan_profile, networks.Networks.delete_network_vlan_profile, networks.Networks.update_network_vlan_profile,
- Используемые пути: post /networks/{networkId}/vlanProfiles, delete /networks/{networkId}/vlanProfiles/{iname}, put /networks/{networkId}/vlanProfiles/{iname},
- Не поддерживает
check_mode - Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
- из Cisco Dashboard API Python(SDK)
- Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения
См. также
См. также
- Документация Cisco Meraki по networks createNetworkVlanProfile
-
Полное описание API createNetworkVlanProfile.
- Документация Cisco Meraki по networks deleteNetworkVlanProfile
-
Полное описание API deleteNetworkVlanProfile.
- Документация Cisco Meraki по networks updateNetworkVlanProfile
-
Полное описание API updateNetworkVlanProfile.
Примеры
- name: Create
cisco.meraki.networks_vlan_profiles:
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
iname: Profile1
name: My VLAN profile name
networkId: string
vlanGroups:
- name: named-group-1
vlanIds: 2,5-7
vlanNames:
- adaptivePolicyGroup:
id: '791'
name: named-1
vlanId: '1'
- name: Update by name
cisco.meraki.networks_vlan_profiles:
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
iname: string
name: My VLAN profile name
networkId: string
vlanGroups:
- name: named-group-1
vlanIds: 2,5-7
vlanNames:
- adaptivePolicyGroup:
id: '791'
name: named-1
vlanId: '1'
- name: Delete by name
cisco.meraki.networks_vlan_profiles:
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
iname: string
networkId: string
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response dictionary | Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/networks_vlan_profiles_module.html