cisco.meraki.networks_switch_port_schedules module – Модуль ресурсов для networks _switch _portschedules

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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), время ожидания перед повторной попыткой при ответе 429 от Nginx По умолчанию: `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	Имя расписания портов. Обязательный параметр.
networkId string	Параметр пути NetworkId. Идентификатор сети.
portSchedule dictionary	Расписание для планирования работы портов коммутатора. Расписание задаётся для дней недели. Если оно пустое, настраивается расписание по умолчанию для всех дней недели. Для каждого дня, не указанного в расписании, добавляется конфигурация расписания по умолчанию.
friday dictionary	Объект расписания для пятницы.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
monday dictionary	Объект расписания для понедельника.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
saturday dictionary	Объект расписания для субботы.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
sunday dictionary	Объект расписания для воскресенья.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
thursday dictionary	Объект расписания для четверга.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
tuesday dictionary	Объект расписания для вторника.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
wednesday dictionary	Объект расписания для среды.
active boolean	Указывает, активно (true) или неактивно (false) расписание в период времени между значениями «from» и «to». По умолчанию — true. Варианты: `false` `true`
from string	Время от «00 00» до «24 00». Должно быть меньше времени, указанного в «to». По умолчанию — «00 00». Допускаются только интервалы в 30 минут.
to string	Время от «00 00» до «24 00». Должно быть больше времени, указанного в «from». По умолчанию — «24 00». Допускаются только интервалы в 30 минут.
portScheduleId string	Параметр пути PortScheduleId. Идентификатор расписания портов.

Примечания

Примечание

Используются методы SDK: switch.Switch.create_network_switch_port_schedule, switch.Switch.delete_network_switch_port_schedule, switch.Switch.update_network_switch_port_schedule,
Используются пути: post /networks/{networkId}/switch/portSchedules, delete /networks/{networkId}/switch/portSchedules/{portScheduleId}, put /networks/{networkId}/switch/portSchedules/{portScheduleId},
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по switch createNetworkSwitchPortSchedule: Полное описание API createNetworkSwitchPortSchedule.
Документация Cisco Meraki по switch deleteNetworkSwitchPortSchedule: Полное описание API deleteNetworkSwitchPortSchedule.
Документация Cisco Meraki по switch updateNetworkSwitchPortSchedule: Полное описание API updateNetworkSwitchPortSchedule.

Примеры

- name: Create
  cisco.meraki.networks_switch_port_schedules:
    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
    name: Weekdays schedule
    networkId: string
    portSchedule:
      friday:
        active: true
        from: '9:00'
        to: '17:00'
      monday:
        active: true
        from: '9:00'
        to: '17:00'
      saturday:
        active: false
        from: 0:00
        to: '24:00'
      sunday:
        active: false
        from: 0:00
        to: '24:00'
      thursday:
        active: true
        from: '9:00'
        to: '17:00'
      tuesday:
        active: true
        from: '9:00'
        to: '17:00'
      wednesday:
        active: true
        from: '9:00'
        to: '17:00'
- name: Delete by id
  cisco.meraki.networks_switch_port_schedules:
    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
    networkId: string
    portScheduleId: string
- name: Update by id
  cisco.meraki.networks_switch_port_schedules:
    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
    name: Weekdays schedule
    networkId: string
    portSchedule:
      friday:
        active: true
        from: '9:00'
        to: '17:00'
      monday:
        active: true
        from: '9:00'
        to: '17:00'
      saturday:
        active: false
        from: 0:00
        to: '24:00'
      sunday:
        active: false
        from: 0:00
        to: '24:00'
      thursday:
        active: true
        from: '9:00'
        to: '17:00'
      tuesday:
        active: true
        from: '9:00'
        to: '17:00'
      wednesday:
        active: true
        from: '9:00'
        to: '17:00'
    portScheduleId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: {"id": "string", "name": "string", "networkId": "string", "portSchedule": {"friday": {"active": true, "from": "string", "to": "string"}, "monday": {"active": true, "from": "string", "to": "string"}, "saturday": {"active": true, "from": "string", "to": "string"}, "sunday": {"active": true, "from": "string", "to": "string"}, "thursday": {"active": true, "from": "string", "to": "string"}, "tuesday": {"active": true, "from": "string", "to": "string"}, "wednesday": {"active": true, "from": "string", "to": "string"}}}

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"id": "string", "name": "string", "networkId": "string", "portSchedule": {"friday": {"active": true, "from": "string", "to": "string"}, "monday": {"active": true, "from": "string", "to": "string"}, "saturday": {"active": true, "from": "string", "to": "string"}, "sunday": {"active": true, "from": "string", "to": "string"}, "thursday": {"active": true, "from": "string", "to": "string"}, "tuesday": {"active": true, "from": "string", "to": "string"}, "wednesday": {"active": true, "from": "string", "to": "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/networks_switch_port_schedules_module.html