fortinet.fortios.fortios_system_console 模块 – 在 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_system_console

fortinet.fortios 2.0.0 中的新功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改系统功能和控制台类别。示例包括在使用前需要根据数据源调整的所有参数和值。使用 FOS v6.0.0 进行测试

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性,则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

system_console

字典

配置控制台。

baudrate

字符串

控制台波特率。

选项

  • "9600"

  • "19200"

  • "38400"

  • "57600"

  • "115200"

fortiexplorer

字符串

启用/禁用 FortiExplorer 的访问。

选项

  • "enable"

  • "disable"

login

字符串

启用/禁用串行控制台和 FortiExplorer。

选项

  • "enable"

  • "disable"

mode

字符串

控制台模式。

选项

  • "batch"

  • "line"

output

字符串

控制台输出模式。

选项

  • "standard"

  • "more"

vdom

字符串

虚拟域,在之前定义的那些中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认值: "root"

注释

注意

  • 旧版 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式

示例

- name: Configure console.
  fortinet.fortios.fortios_system_console:
      vdom: "{{ vdom }}"
      system_console:
          baudrate: "9600"
          fortiexplorer: "enable"
          login: "enable"
          mode: "batch"
          output: "standard"

返回值

通用返回值记录在 此处,以下是此模块独有的字段

描述

build

字符串

FortiGate 映像的版本号

返回: 总是

示例: "1547"

http_method

字符串

用于将内容配置到 FortiGate 的最后一种方法

返回: 总是

示例: "PUT"

http_status

字符串

FortiGate 在上次应用操作时给出的最后一个结果

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回: 成功

示例: "id"

name

字符串

用于完成请求的表名称

返回: 总是

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回: 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回: 总是

示例: "root"

version

字符串

FortiGate 的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)