fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress 模块 – 用于 DHCP 服务器为特定 MAC 地址分配 IP 设置的选项。

注意

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

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

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

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

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 客户端。
proposed_method 字符串	用于底层 Json RPC 请求的覆盖方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
server 字符串 / 必需	请求 URL 中的参数 (server)。
state 字符串 / 必需	用于创建、更新或删除对象的指令。选择 `"present"` `"absent"`
system_dhcp_server_reservedaddress 字典	设置的顶级参数。
action 字符串	用于配置具有保留 MAC 地址的客户端的 DHCP 服务器的选项。选择 `"assign"` `"block"` `"reserved"`
circuit_id 别名：circuit-id 字符串	将获取保留 IP 地址的客户端的选项 82 电路 ID。
circuit_id_type 别名：circuit-id-type 字符串	DHCP 选项类型。选择 `"hex"` `"string"`
description 字符串	描述。
id 整数 / 必需	ID。
ip 字符串	为 MAC 地址保留的 IP 地址。
mac 字符串	将获取保留 IP 地址的客户端的 MAC 地址。
remote_id 别名：remote-id 字符串	将获取保留 IP 地址的客户端的选项 82 远程 ID。
remote_id_type 别名：remote-id-type 字符串	DHCP 选项类型。选择 `"hex"` `"string"`
type 字符串	DHCP 保留地址类型。选择 `"mac"` `"option82"`
workspace_locking_adom 字符串	用于在工作区模式下运行的 FortiManager 的要锁定的 adom，该值可以是全局的，也可以是包括 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 有助于完成工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件

示例 

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Options for the DHCP server to assign IP settings to specific MAC addresses.
      fortinet.fortimanager.fmgr_system_dhcp_server_reservedaddress:
        bypass_validation: false
        adom: ansible
        server: 1 # id
        state: present
        system_dhcp_server_reservedaddress:
          action: assign # <value in [assign, block, reserved]>
          description: ansible-description
          id: 1
          ip: 222.222.222.1

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the reserved addresses of DHCP server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_dhcp_server_reservedaddress"
          params:
            adom: "ansible"
            server: "1" # id
            reserved-address: "your_value"

返回值 

常见返回值记录在此处，以下是此模块独有的字段

键	描述
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)