fortinet.fortimanager.fmgr_switchcontroller_lldpprofile 模块 – 配置 FortiSwitch LLDP 配置文件。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_switchcontroller_lldpprofile。
在 fortinet.fortimanager 2.0.0 中新增
概要
此模块能够配置 FortiManager 设备。
示例包括在使用前需要调整为数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构存在差异时才设置为 True，模块将在不验证参数的情况下继续执行。 选择
|
|
启用/禁用任务的日志记录。 选择
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
底层 Json RPC 请求的覆盖方法。 选择
|
|
将被覆盖的失败条件的 rc 代码列表。 |
|
将被覆盖的成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选择
|
|
设置的顶级参数。 |
|
已传输的 IEEE 802。 选择
|
|
已传输的 IEEE 802。 选择
|
|
启用/禁用自动交换机间 LAG。 选择
|
|
自动交换机间 LAG 身份验证模式。 选择
|
|
自动交换机间 LAG 加密模式。 选择
|
|
自动交换机间 LAG 身份验证身份。 |
|
用于加密的自动交换机间 LAG macsec 配置文件。 |
|
自动交换机间 LAG 身份验证重新认证周期，以秒为单位 |
|
自动交换机间 LAG 身份验证用户证书。 |
|
自动交换机间 LAG hello 定时器持续时间 |
|
自动交换机间 LAG 端口组 ID |
|
如果未收到响应，则自动交换机间 LAG 超时 |
|
启用/禁用 MCLAG 机箱间链路。 选择
|
|
自定义 tlvs。 |
|
组织定义的字符串信息 |
|
TLV 名称 |
|
组织唯一标识符 |
|
组织定义的子类型 |
|
Med 位置服务。 |
|
位置服务类型名称。 |
|
启用或禁用此 TLV。 选择
|
|
位置服务 ID。 |
|
Med 网络策略。 |
|
在此配置文件应用于受管 FortiSwitch 端口时启用/禁用 VLAN 分配。 选择
|
|
通告的差分服务代码点 |
|
策略类型名称。 |
|
通告的第 2 层优先级 |
|
启用或禁用此 TLV。 选择
|
|
如果配置在端口上，则为要通告的 VLAN 的 ID |
|
要通告的 VLAN 接口；如果配置在端口上。 |
|
传输的 LLDP-MED TLV 选择
|
|
配置文件名称。 |
|
在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他（包括 root）。 |
|
等待其他用户释放工作区锁的最长时间（秒）。 默认值： |
注意
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件
示例
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch LLDP profiles.
fortinet.fortimanager.fmgr_switchcontroller_lldpprofile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
switchcontroller_lldpprofile:
802_1_tlvs:
- "port-vlan-id"
802_3_tlvs:
- "max-frame-size"
- "power-negotiation"
auto_isl: <value in [disable, enable]>
auto_isl_hello_timer: <integer>
auto_isl_port_group: <integer>
auto_isl_receive_timeout: <integer>
custom_tlvs:
-
information_string: <string>
name: <string>
oui: <string>
subtype: <integer>
med_network_policy:
-
dscp: <integer>
name: <string>
priority: <integer>
status: <value in [disable, enable]>
vlan: <integer>
vlan_intf: <string>
assign_vlan: <value in [disable, enable]>
med_tlvs:
- "inventory-management"
- "network-policy"
- "power-management"
- "location-identification"
name: <string>
med_location_service:
-
name: <string>
status: <value in [disable, enable]>
sys_location_id: <string>
auto_mclag_icl: <value in [disable, enable]>
auto_isl_auth: <value in [legacy, strict, relax]>
auto_isl_auth_encrypt: <value in [none, mixed, must]>
auto_isl_auth_identity: <string>
auto_isl_auth_macsec_profile: <string>
auto_isl_auth_reauth: <integer>
auto_isl_auth_user: <string>
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回： 始终 |
|
请求的完整 URL。 返回： 始终 示例： |
|
API 请求的状态。 返回： 始终 示例： |
|
API 响应。 返回： 始终 |
|
API 响应的描述性消息。 返回： 始终 示例： |
|
目标系统的信息。 返回： 始终 |
|
请求的状态。 返回： 始终 示例： |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回： 复杂 |