cisco.meraki.networks_switch_port_schedules 模块 – 用于网络交换机端口计划的资源模块

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在剧本中使用它，请指定：cisco.meraki.networks_switch_port_schedules。

cisco.meraki 2.16.0 中的新功能

概要 

管理资源网络交换机端口计划的创建、更新和删除操作。
添加交换机端口计划。
删除交换机端口计划。
更新交换机端口计划。

注意

此模块有一个对应的操作插件。

要求 

在执行此模块的主机上需要以下要求。

meraki >= 2.4.9
python >= 3.5

参数 

参数	注释
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time（整数），操作批处理并发错误重试等待时间默认值： `60`
meraki_api_key 字符串 / 必填	meraki_api_key（字符串），在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url（字符串），所有端点资源的前缀默认值： `"https://api.meraki.com/api/v1"`
meraki_be_geo_id 字符串	meraki_be_geo_id（字符串），用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： `""`
meraki_caller 字符串	meraki_caller（字符串），用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： `""`
meraki_certificate_path 字符串	meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径默认值： `""`
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config（布尔值），继承您自己的记录器实例选项 `false` ←（默认） `true`
meraki_log_file_prefix 字符串	meraki_log_file_prefix（字符串），附加了日期和时间戳的日志文件名默认值： `"meraki_api_"`
meraki_log_path 字符串	log_path（字符串），输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录默认值： `""`
meraki_maximum_retries 整数	meraki_maximum_retries（整数），在遇到 429 或其他服务器端错误时，最多重试这么多次默认值： `2`
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间默认值： `60`
meraki_output_log 布尔值	meraki_output_log（布尔值），创建输出日志文件？选项 `false` `true` ←（默认）
meraki_print_console 布尔值	meraki_print_console（布尔值），将日志输出打印到控制台？选项 `false` `true` ←（默认）
meraki_requests_proxy 字符串	meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口默认值： `""`
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429），是否重试？选项 `false` ←（默认） `true`
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间默认值： `60`
meraki_simulate 布尔值	meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？选项 `false` ←（默认） `true`
meraki_single_request_timeout 整数	meraki_single_request_timeout（整数），每次 API 调用的最大秒数默认值： `60`
meraki_suppress_logging 布尔值	meraki_suppress_logging（布尔值），禁用所有日志记录？那么您就只能靠自己了！选项 `false` ←（默认） `true`
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回一个带有每个对象的迭代器，而不是包含所有项的完整列表选项 `false` ←（默认） `true`
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit（布尔值），如果遇到 429 速率限制错误，是否重试？选项 `false` `true` ←（默认）
name 字符串	您的端口计划的名称。必填。
networkId 字符串	NetworkId 路径参数。网络 ID。
portSchedule 字典	交换机端口调度的计划。计划应用于一周中的几天。当它为空时，配置一周中所有天的默认计划。计划中未指定的任何一天都会添加为该天的默认计划配置。
friday 字典	周五的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
monday 字典	周一的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
saturday 字典	周六的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
sunday 字典	周日的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
thursday 字典	周四的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
tuesday 字典	周二的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
wednesday 字典	周三的计划对象。
active 布尔值	在“from”和“to”之间指定的时间内，计划是活动的（true）还是非活动的（false）。默认为 true。选项 `false` `true`
from 字符串	时间，从“00 00”到“24 00”。必须小于“to”中指定的时间。默认为“00 00”。只允许 30 分钟的增量。
to 字符串	时间，从“00 00”到“24 00”。必须大于“from”中指定的时间。默认为“24 00”。只允许 30 分钟的增量。
portScheduleId 字符串	PortScheduleId 路径参数。端口计划 ID。

注意 

注意

使用的 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 关于交换机 createNetworkSwitchPortSchedule 的文档。: createNetworkSwitchPortSchedule API 的完整参考。
Cisco Meraki 关于交换机 deleteNetworkSwitchPortSchedule 的文档。: deleteNetworkSwitchPortSchedule API 的完整参考。
Cisco Meraki 关于交换机 updateNetworkSwitchPortSchedule 的文档。: updateNetworkSwitchPortSchedule API 的完整参考。

示例 

- 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"}}}

作者

Francisco Munoz (@fmunoz)