fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange 模块 – DHCP IP 地址范围配置。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange。

fortinet.fortimanager 2.0.0 中的新功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括在使用前需要调整到数据源的所有参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必填

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

dynamic_mapping

字符串 / 必填

请求的 URL 中的参数 (dynamic_mapping)。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌验证 Ansible 客户端。

fsp_vlan_dynamicmapping_dhcpserver_iprange

字典

设置的顶层参数。

end_ip

别名：end-ip

字符串

结束 IP 地址。

id

整数 / 必填

ID。

lease_time

别名：lease-time

整数

租约时间（以秒为单位），0 表示默认租约时间。

start_ip

别名：start-ip

字符串

起始 IP 地址。

uci_match

别名：uci-match

字符串

启用/禁用用户类标识符

选项

  • "disable"

  • "enable"

uci_string

别名：uci-string

任何

（列表）一个或多个以空格分隔并用引号括起来的 UCI 字符串。

vci_match

别名：vci-match

字符串

启用/禁用供应商类标识符

选项

  • "disable"

  • "enable"

vci_string

别名：vci-string

任何

（列表）一个或多个以空格分隔并用引号括起来的 VCI 字符串。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必填

用于创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

vlan

字符串 / 必填

请求的 URL 中的参数 (vlan)。

workspace_locking_adom

字符串

FortiManager 在工作区模式下运行时要锁定的 ADOM，该值可以是 global 以及其他包括 root 的值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（以秒为单位）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 要创建或更新对象，请使用状态 present 指令。

  • 要删除对象，请使用状态 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: DHCP IP range configuration.
      fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_dhcpserver_iprange:
        # 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>
        vlan: <your own value>
        dynamic_mapping: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_dynamicmapping_dhcpserver_iprange:
          end_ip: <string>
          id: <integer>
          start_ip: <string>
          vci_match: <value in [disable, enable]>
          vci_string: <list or string>
          lease_time: <integer>
          uci_match: <value in [disable, enable]>
          uci_string: <list or string>

返回值

常见的返回值已记录在这里，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

完整的请求URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API请求的状态码。

返回: 总是

示例: 0

response_data

列表 / 元素=字符串

API响应数据。

返回: 总是

response_message

字符串

API响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / 元素=字符串

如果playbook中使用的参数不被当前FortiManager版本支持，则会发出警告。

返回: 复杂类型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)