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