fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver 模块 – 配置 DHCP 服务器。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

fsp_vlan_dhcpserver

字典

设置的顶级参数。

auto_configuration

别名：auto-configuration

字符串

自动配置。

选项

  • "disable"

  • "enable"

auto_managed_status

别名：auto-managed-status

字符串

自动管理状态。

选项

  • "disable"

  • "enable"

conflicted_ip_timeout

别名：conflicted-ip-timeout

整数

冲突 IP 超时。

ddns_auth

别名：ddns-auth

字符串

DDNS 认证。

选项

  • "disable"

  • "tsig"

ddns_key

别名：ddns-key

任意

(列表或字符串) DDNS 密钥。

ddns_keyname

别名：ddns-keyname

字符串

DDNS 密钥名称。

ddns_server_ip

别名：ddns-server-ip

字符串

DDNS 服务器 IP。

ddns_ttl

别名：ddns-ttl

整数

DDNS TTL。

ddns_update

别名：ddns-update

字符串

DDNS 更新。

选项

  • "disable"

  • "enable"

ddns_update_override

别名：ddns-update-override

字符串

DDNS 更新覆盖。

选项

  • "disable"

  • "enable"

ddns_zone

别名：ddns-zone

字符串

DDNS 区域。

default_gateway

别名：default-gateway

字符串

默认网关。

dhcp_settings_from_fortiipam

别名：dhcp-settings-from-fortiipam

字符串

来自 FortiIPAM 的 DHCP 设置。

选项

  • "disable"

  • "enable"

dns_server1

别名：dns-server1

字符串

DNS 服务器 1。

dns_server2

别名：dns-server2

字符串

DNS 服务器 2。

dns_server3

别名：dns-server3

字符串

DNS 服务器 3。

dns_server4

别名：dns-server4

字符串

DNS 服务器 4。

dns_service

别名：dns-service

字符串

DNS 服务。

选项

  • "default"

  • "specify"

  • "local"

domain

字符串

域名。

enable

字符串

启用。

选项

  • "disable"

  • "enable"

exclude_range

别名：exclude-range

列表 / 元素=字典

排除范围。

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字符串。

文件名

字符串

文件名。

forticlient_on_net_status

别名：forticlient-on-net-status

字符串

FortiClient网络状态。

选项

  • "disable"

  • "enable"

id

整数

ID。

接口

字符串

接口。

ip_mode

别名：ip-mode

字符串

IP模式。

选项

  • "range"

  • "usrgrp"

ip_range

别名：ip-range

列表 / 元素=字典

IP范围。

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字符串。

ipsec_lease_hold

别名：ipsec-lease-hold

整数

IPsec租期保持时间。

lease_time

别名：lease-time

整数

租期时间。

mac_acl_default_action

别名：mac-acl-default-action

字符串

MAC ACL默认动作。

选项

  • "assign"

  • "block"

子网掩码

字符串

子网掩码。

next_server

别名：next-server

字符串

下一跳服务器。

ntp_server1

别名：ntp-server1

字符串

NTP服务器1。

ntp_server2

别名：ntp-server2

字符串

NTP服务器2。

ntp_server3

别名：ntp-server3

字符串

NTP服务器3。

ntp_service

别名：ntp-service

字符串

NTP服务。

选项

  • "default"

  • "specify"

  • "local"

option1

任意

（列表）Option1。

option2

任意

（列表）Option2。

option3

任意

（列表）Option3。

option4

字符串

Option4。

option5

字符串

Option5。

option6

字符串

Option6。

options

列表 / 元素=字典

选项。

代码

整数

代码。

id

整数

ID。

IP

任意

（列表）IP。

类型

字符串

类型。

选项

  • "hex"

  • "string"

  • "ip"

  • "fqdn"

uci_match

别名：uci-match

字符串

启用/禁用用户类标识符

选项

  • "disable"

  • "enable"

uci_string

别名：uci-string

任意

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

值

字符串

值。

vci_match

别名：vci-match

字符串

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

选项

  • "disable"

  • "enable"

vci_string

别名：vci-string

任意

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

relay_agent

别名：relay-agent

字符串

中继代理IP。

reserved_address

别名：reserved-address

列表 / 元素=字典

保留地址。

action

字符串

动作。

选项

  • "assign"

  • "block"

  • "reserved"

circuit_id

别名：circuit-id

字符串

电路ID。

circuit_id_type

别名：circuit-id-type

字符串

电路ID类型。

选项

  • "hex"

  • "string"

description

字符串

描述。

id

整数

ID。

ip

字符串

IP。

mac

字符串

MAC地址。

remote_id

别名：remote-id

字符串

远程ID。

remote_id_type

别名：remote-id-type

字符串

远程ID类型。

选项

  • "hex"

  • "string"

type

字符串

类型。

选项

  • "mac"

  • "option82"

server_type

别名：server-type

字符串

服务器类型。

选项

  • "regular"

  • "ipsec"

shared_subnet

别名：shared-subnet

字符串

启用/禁用共享子网。

选项

  • "disable"

  • "enable"

状态

字符串

状态。

选项

  • "disable"

  • "enable"

tftp_server

别名：tftp-server

任意

（列表）TFTP服务器。

时区

字符串

时区。

选项

  • "00"

  • "01"

  • "02"

  • "03"

  • "04"

  • "05"

  • "06"

  • "07"

  • "08"

  • "09"

  • "10"

  • "11"

  • "12"

  • "13"

  • "14"

  • "15"

  • "16"

  • "17"

  • "18"

  • "19"

  • "20"

  • "21"

  • "22"

  • "23"

  • "24"

  • "25"

  • "26"

  • "27"

  • "28"

  • "29"

  • "30"

  • "31"

  • "32"

  • "33"

  • "34"

  • "35"

  • "36"

  • "37"

  • "38"

  • "39"

  • "40"

  • "41"

  • "42"

  • "43"

  • "44"

  • "45"

  • "46"

  • "47"

  • "48"

  • "49"

  • "50"

  • "51"

  • "52"

  • "53"

  • "54"

  • "55"

  • "56"

  • "57"

  • "58"

  • "59"

  • "60"

  • "61"

  • "62"

  • "63"

  • "64"

  • "65"

  • "66"

  • "67"

  • "68"

  • "69"

  • "70"

  • "71"

  • "72"

  • "73"

  • "74"

  • "75"

  • "76"

  • "77"

  • "78"

  • "79"

  • "80"

  • "81"

  • "82"

  • "83"

  • "84"

  • "85"

  • "86"

  • "87"

timezone_option

别名：timezone-option

字符串

时区选项。

选项

  • "disable"

  • "default"

  • "specify"

vci_match

别名：vci-match

字符串

VCI匹配。

选项

  • "disable"

  • "enable"

vci_string

别名：vci-string

任意

（列表）VCI字符串。

wifi_ac1

别名：wifi-ac1

字符串

Wifi AC1。

wifi_ac2

别名：wifi-ac2

字符串

Wifi AC2。

wifi_ac3

别名：wifi-ac3

字符串

Wifi AC3。

wifi_ac_service

别名：wifi-ac-service

字符串

Wifi AC服务。

选项

  • "specify"

  • "local"

wins_server1

别名：wins-server1

字符串

WINS服务器1。

wins_server2

别名：wins-server2

字符串

WINS服务器2。

建议的方法

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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有助于完成这项工作。

  • 通常，当返回非零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 DHCP servers.
      fortinet.fortimanager.fmgr_fsp_vlan_dhcpserver:
        # 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>
        fsp_vlan_dhcpserver:
          auto_configuration: <value in [disable, enable]>
          conflicted_ip_timeout: <integer>
          ddns_auth: <value in [disable, tsig]>
          ddns_key: <list or string>
          ddns_keyname: <string>
          ddns_server_ip: <string>
          ddns_ttl: <integer>
          ddns_update: <value in [disable, enable]>
          ddns_update_override: <value in [disable, enable]>
          ddns_zone: <string>
          default_gateway: <string>
          dns_server1: <string>
          dns_server2: <string>
          dns_server3: <string>
          dns_service: <value in [default, specify, local]>
          domain: <string>
          enable: <value in [disable, enable]>
          exclude_range:
            -
              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>
          filename: <string>
          forticlient_on_net_status: <value in [disable, enable]>
          id: <integer>
          interface: <string>
          ip_mode: <value in [range, usrgrp]>
          ip_range:
            -
              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>
          ipsec_lease_hold: <integer>
          lease_time: <integer>
          mac_acl_default_action: <value in [assign, block]>
          netmask: <string>
          next_server: <string>
          ntp_server1: <string>
          ntp_server2: <string>
          ntp_server3: <string>
          ntp_service: <value in [default, specify, local]>
          option1: <list or string>
          option2: <list or string>
          option3: <list or string>
          option4: <string>
          option5: <string>
          option6: <string>
          options:
            -
              code: <integer>
              id: <integer>
              ip: <list or string>
              type: <value in [hex, string, ip, ...]>
              value: <string>
              vci_match: <value in [disable, enable]>
              vci_string: <list or string>
              uci_match: <value in [disable, enable]>
              uci_string: <list or string>
          reserved_address:
            -
              action: <value in [assign, block, reserved]>
              circuit_id: <string>
              circuit_id_type: <value in [hex, string]>
              description: <string>
              id: <integer>
              ip: <string>
              mac: <string>
              remote_id: <string>
              remote_id_type: <value in [hex, string]>
              type: <value in [mac, option82]>
          server_type: <value in [regular, ipsec]>
          status: <value in [disable, enable]>
          tftp_server: <list or string>
          timezone: <value in [00, 01, 02, ...]>
          timezone_option: <value in [disable, default, specify]>
          vci_match: <value in [disable, enable]>
          vci_string: <list or string>
          wifi_ac1: <string>
          wifi_ac2: <string>
          wifi_ac3: <string>
          wins_server1: <string>
          wins_server2: <string>
          dns_server4: <string>
          wifi_ac_service: <value in [specify, local]>
          auto_managed_status: <value in [disable, enable]>
          dhcp_settings_from_fortiipam: <value in [disable, enable]>
          relay_agent: <string>
          shared_subnet: <value in [disable, enable]>

返回值

公共返回值已在此处记录，以下是此模块特有的字段

键

描述

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

列表 / 元素=字符串

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

返回： complex

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)