cisco.meraki.meraki_ms_switchport 模块 – 管理 Meraki 云中交换机的交换机端口

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_ms_switchport。

已弃用 

在以下版本中移除：: 3.0.0 版本
原因：: 发布了具有增强功能的更新模块
替代方案：: cisco.meraki.devices_switch_ports

概要 

允许管理 Meraki MS 交换机的交换机端口设置。

参数 

参数	注释
access_policy_number 整数	要应用的访问策略编号。仅适用于访问端口类型。
access_policy_type 字符串	要应用于端口的访问策略类型。选项 `"开放"` `"自定义访问策略"` `"MAC 允许列表"` `"粘性 MAC 允许列表"`
allowed_vlans 列表 / 元素=字符串	允许在交换机端口上使用的 VLAN 号码列表。默认值： `["all"]`
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 `MERAKI_KEY`，则需要此密钥。
enabled 布尔值	交换机端口是否应启用或禁用。选项 `false` `true` ← (默认)
flexible_stacking_enabled 布尔值	端口是否支持灵活堆叠功能。选项 `false` `true`
host 字符串	Meraki 仪表盘的主机名。可用于访问区域性 Meraki 环境，例如中国。默认值： `"api.meraki.com"`
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。默认值： `60`
isolation_enabled 布尔值	交换机端口的隔离状态。选项 `false` ← (默认) `true`
link_negotiation 字符串	交换机端口的链路速度。选项 `"1 Gigabit 全双工 (自动)"` `"1 Gigabit 全双工 (强制)"` `"10 Gigabit 全双工 (自动)"` `"10 Gigabit 全双工 (强制)"` `"100 Megabit (自动)"` `"100 Megabit 全双工 (强制)"` `"2.5 Gigabit 全双工 (自动)"` `"2.5 Gigabit 全双工 (强制)"` `"5 Gigabit 全双工 (自动)"` `"5 Gigabit 全双工 (强制)"` `"自动协商"` ← (默认)
mac_allow_list 字典	端口上允许的 MAC 地址列表。仅适用于访问端口类型。仅适用于 access_policy_type “MAC 允许列表”。
macs 列表 / 元素=字符串	基于状态选项更新的 MAC 地址列表。
state 字符串	配置应保留的状态。合并，提供的 MAC 地址将添加到当前允许列表。替换，所有 MAC 地址都将被覆盖，只有提供的 MAC 地址存在于允许列表中。删除，从当前允许列表中删除提供的 MAC 地址。选项 `"merged"` `"replaced"` ← (默认) `"deleted"`
name 别名：description 字符串	交换机端口描述。
number 字符串	端口号。
org_id 字符串	组织 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 `net_id`) 还是驼峰命名法 (例如 `netId`)。选项 `"snakecase"` ← (默认) `"camelcase"`
output_level 字符串	设置模块执行期间调试输出的数量。选项 `"debug"` `"normal"` ← (默认)
poe_enabled 布尔值	启用或禁用端口上的以太网供电。选项 `false` `true` ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。默认值： `165`
rstp_enabled 布尔值	启用或禁用端口上的快速生成树协议。选项 `false` `true` ← (默认)
serial 字符串 / 必需	交换机的序列号。
state 字符串	指定是否应查询或修改交换机端口。选项 `"query"` ← (默认) `"present"`
sticky_mac_allow_list 字典	端口上允许的 MAC 地址列表。仅适用于访问端口类型。仅适用于 access_policy_type 为“Sticky MAC 允许列表”的情况。
macs 列表 / 元素=字符串	基于状态选项更新的 MAC 地址列表。
state 字符串	配置应保留的状态。合并，提供的 MAC 地址将添加到当前允许列表。替换，所有 MAC 地址都将被覆盖，只有提供的 MAC 地址存在于允许列表中。删除，从当前允许列表中删除提供的 MAC 地址。选项 `"merged"` `"replaced"` ← (默认) `"deleted"`
sticky_mac_allow_list_limit 整数	粘性端口允许列表中允许的 MAC 地址数量。仅适用于访问端口类型。仅适用于 access_policy_type 为“Sticky MAC 允许列表”的情况。该值必须等于或大于 sticky_mac_allow_list 列表的大小。在处理过程中将检查该值的有效性。
stp_guard 字符串	设置 STP 保护的状态。选项 `"disabled"` ← (默认) `"root guard"` `"bpdu guard"` `"loop guard"`
tags 列表 / 元素=字符串	要分配给端口的标签列表。
timeout 整数	HTTP 请求的超时时间。默认： `30`
type 字符串	设置端口类型。选项 `"access"` ← (默认) `"trunk"`
use_https 布尔值	如果为 `no`，则使用 HTTP。否则，将使用 HTTPS。仅对 Meraki 内部开发人员有用。选项 `false` `true` ← (默认)
use_proxy 布尔值	如果为 `no`，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。选项 `false` ← (默认) `true`
validate_certs 布尔值	是否验证 HTTP 证书。选项 `false` `true` ← (默认)
vlan 整数	分配给端口的 VLAN 号。如果端口类型为 trunk，则指定的 VLAN 为原生 VLAN。在 trunk 上将值设置为 0 将清除 VLAN。
voice_vlan 整数	分配给端口的用于语音流量的 VLAN 号。仅适用于访问端口类型。仅当 voice_vlan_state 设置为 present 时适用。
voice_vlan_state 字符串	指定语音 VLAN 配置是否存在。选项 `"absent"` `"present"` ← (默认)

备注 

注意

有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。
某些选项可能仅供 Meraki 内部开发人员使用。
从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。
Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的剧本。
检查模式会从仪表板下载当前配置，然后将更改与该下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例 

- name: Query information about all switchports on a switch
  meraki_switchport:
    auth_key: abc12345
    state: query
    serial: ABC-123
  delegate_to: localhost

- name: Query information about all switchports on a switch
  meraki_switchport:
    auth_key: abc12345
    state: query
    serial: ABC-123
    number: 2
  delegate_to: localhost

- name: Name switchport
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    name: Test Port
  delegate_to: localhost

- name: Configure access port with voice VLAN
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Test Port
    tags: desktop
    type: access
    vlan: 10
    voice_vlan: 11
  delegate_to: localhost

- name: Check access port for idempotency
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Test Port
    tags: desktop
    type: access
    vlan: 10
    voice_vlan: 11
  delegate_to: localhost

- name: Configure trunk port with specific VLANs
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 7
    enabled: true
    name: Server port
    tags: server
    type: trunk
    allowed_vlans:
      - 10
      - 15
      - 20
  delegate_to: localhost

- name: Configure access port with sticky MAC allow list and limit.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_limit: 3
    sticky_mac_allow_list:
        macs:
          - aa:aa:bb:bb:cc:cc
          - bb:bb:aa:aa:cc:cc
          - 11:aa:bb:bb:cc:cc
        state: replaced
    delegate_to: localhost

- name: Delete an existing MAC address from the sticky MAC allow list.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_list:
        macs:
          - aa:aa:bb:bb:cc:cc
        state: deleted
    delegate_to: localhost

- name: Add a MAC address to sticky MAC allow list.
  meraki_switchport:
    auth_key: abc12345
    state: present
    serial: ABC-123
    number: 5
    sticky_mac_allow_list:
        macs:
          - 22:22:bb:bb:cc:cc
        state: merged
    delegate_to: localhost

返回值 

常用的返回值已在此处记录，以下是此模块特有的字段

键	描述
data complex	查询或更新的交换机端口信息。返回：成功
access_policy_number 整数	已分配的访问策略数量。仅适用于接入端口。返回：成功示例： `1234`
access_policy_type 字符串	分配给端口的访问策略类型返回：分配时成功示例： `"MAC allow list"`
allowed_vlans 字符串	接入端口上允许的 VLAN 列表返回：端口设置为接入端口时成功示例： `"all"`
enabled 布尔值	端口的启用状态。返回：成功示例： `true`
flexible_stacking_enabled 布尔值	端口上是否启用了灵活堆叠功能。返回：成功
isolation_enabled 布尔值	端口的端口隔离状态。返回：成功示例： `true`
link_negotiation 字符串	端口的链路速度。返回：成功示例： `"Auto negotiate"`
mac_allow_list 列表 / 元素=字符串	当前在非粘性端口上允许的 MAC 地址列表。与 MAC 允许列表的 access_policy_type 一起使用。返回：成功示例： `["11:aa:bb:bb:cc:cc", "22:aa:bb:bb:cc:cc", "33:aa:bb:bb:cc:cc"]`
name 字符串	端口的易于理解的描述。返回：成功示例： `"Jim Phone Port"`
number 整数	端口号。返回：成功示例： `1`
poe_enabled 布尔值	端口的以太网供电启用状态。返回：成功示例： `true`
port_schedule_id 字符串	已分配端口计划的唯一 ID 返回：成功
rstp_enabled 布尔值	快速生成树协议 (RSTP) 的启用或禁用状态返回：成功示例： `true`
sticky_mac_allow_list 列表 / 元素=字符串	当前在粘性端口上允许的 MAC 地址列表。与“粘性 MAC 允许列表”的 access_policy_type 一起使用。返回：成功示例： `["11:aa:bb:bb:cc:cc", "22:aa:bb:bb:cc:cc", "33:aa:bb:bb:cc:cc"]`
sticky_mac_allow_list_limit 整数	粘性端口上允许的 MAC 地址数量。返回：成功示例： `6`
stp_guard 字符串	STP 保护的状态返回：成功示例： `"Root Guard"`
tags 列表 / 元素=字符串	分配给端口的标签列表。返回：成功示例： `["phone", "marketing"]`
type 字符串	交换机端口的类型。返回：成功示例： `"trunk"`
udld 字符串	UDLD 的警报状态返回：成功示例： `"Alert only"`
vlan 整数	分配给端口的 VLAN。返回：成功示例： `10`
voice_vlan 整数	分配给启用了语音 VLAN 的设备的端口的 VLAN。返回：成功示例： `20`

cisco.meraki.meraki_ms_switchport 模块 – 管理 Meraki 云中交换机的交换机端口

已弃用 

概要 

参数 

备注 

示例 

返回值 

状态 

作者

收藏链接

cisco.meraki.meraki_ms_switchport 模块 – 管理 Meraki 云中交换机的交换机端口

已弃用

概要

参数

备注

示例

返回值

状态

作者

收藏链接

已弃用 

概要 

参数 

备注 

示例 

返回值 

状态 