Модуль cisco.meraki.networks_switch_port_schedules – Модуль ресурсов для networks_switch_portschedules

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.networks_switch_port_schedules.

Добавлена в cisco.meraki 2.16.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), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем ресурсам конечной точки Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала, к которому добавляются дата и метка времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки для ошибки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала на консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки для других ошибок 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`

meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя отвечаете! Варианты: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Варианты: `false` `true` ← (default)
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. Choices: `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. Choices: `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. Choices: `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 DNAC 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_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_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_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 словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"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

словарь

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

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

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_switch_port_schedules_module.html