fortinet.fortios.fortios_router_key_chain 模块 – 在 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_router_key_chain
。
fortinet.fortios 2.0.0 中的新功能
概要
此模块能够通过允许用户设置和修改路由器功能和 key_chain 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整为数据源。已使用 FOS v6.0.0 进行测试
要求
执行此模块的主机上需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选择
|
|
要操作的成员属性路径。 如果有多于一个属性,则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选择
|
|
配置密钥链。 |
|
编辑密钥设置的配置方法。 |
|
接收的身份验证密钥的生存期(格式:hh:mm:ss 天 月 年)。 |
|
加密算法。 选择
|
|
密钥 ID (0 - 2147483647)。 |
|
密钥的密码(最大值 = 64 个字符)。 |
|
发送的身份验证密钥的生存期(格式:hh:mm:ss 天 月 年)。 |
|
密钥链名称。 |
|
指示是创建还是删除对象。 选择
|
|
虚拟域,在先前定义的域中。vdom 是 FortiGate 的一个虚拟实例,可以配置并用作不同的单元。 默认值: |
说明
注意
遗留的 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方式
该模块支持 check_mode。
示例
- name: Configure key-chain.
fortinet.fortios.fortios_router_key_chain:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
router_key_chain:
key:
-
accept_lifetime: "<your_own_value>"
algorithm: "md5"
id: "6"
key_string: "<your_own_value>"
send_lifetime: "<your_own_value>"
name: "default_name_9"
返回值
此处记录了常用的返回值 此处,以下是此模块独有的字段
密钥 |
描述 |
---|---|
FortiGate 映像的构建编号 返回值:始终 示例: |
|
上次用于将内容配置到 FortiGate 中的方法 返回值:始终 示例: |
|
FortiGate 在上次应用的操作中给出的最后结果 返回值:始终 示例: |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回值:成功 示例: |
|
用于满足请求的表名称 返回值:始终 示例: |
|
用于满足请求的表路径 返回值:始终 示例: |
|
内部修订号 返回值:始终 示例: |
|
设备的序列号 返回值:始终 示例: |
|
操作结果的指示 返回值:始终 示例: |
|
使用的虚拟域 返回值:始终 示例: |
|
FortiGate 的版本 返回值:始终 示例: |