fortinet.fortios.fortios_switch_controller_switch_group 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch 交换机组。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortios
。您需要其他要求才能使用此模块,请参阅 需求 了解更多详细信息。
要在 playbook 中使用它,请指定: fortinet.fortios.fortios_switch_controller_switch_group
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 switch_controller 功能和 switch_group 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。
需求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
配置 FortiSwitch 交换机组。 |
|
可选的交换机组描述。 |
|
交换机组成员所属的 FortiLink 接口。来源 system.interface.name。 |
|
属于此交换机组的 FortiSwitch 成员。 |
|
被管理设备 ID。来源 switch-controller.managed-switch.switch-id。 |
|
被管理设备 ID。来源 switch-controller.managed-switch.switch-id。 |
|
交换机组名称。 |
|
虚拟域,在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。 默认值: |
备注
注意
旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。
此模块支持 check_mode。
示例
- name: Configure FortiSwitch switch groups.
fortinet.fortios.fortios_switch_controller_switch_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_switch_group:
description: "<your_own_value>"
fortilink: "<your_own_value> (source system.interface.name)"
members:
-
name: "default_name_6 (source switch-controller.managed-switch.switch-id)"
switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
name: "default_name_8"
返回值
常见的返回值已在此处 记录,以下是此模块特有的字段。
键 |
描述 |
---|---|
FortiGate 镜像的版本号 返回: 始终 示例: |
|
上次用于将内容置备到 FortiGate 的方法 返回: 始终 示例: |
|
FortiGate 在上次应用的操作中给出的最后结果 返回: 始终 示例: |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回: 成功 示例: |
|
用于满足请求的表的名称 返回: 始终 示例: |
|
用于满足请求的表的路径 返回: 始终 示例: |
|
内部修订号 返回: 始终 示例: |
|
设备序列号 返回: 始终 示例: |
|
操作结果指示 返回: 始终 示例: |
|
使用的虚拟域 返回: 始终 示例: |
|
FortiGate 版本 返回: 始终 示例: |