fortinet.fortios.fortios_switch_controller_location 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch 位置服务。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求了解详细信息。

要在剧本中使用它，请指定：fortinet.fortios.fortios_switch_controller_location。

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改 switch_controller 功能和位置类别来配置 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"
state 字符串 / 必需	指示是创建还是删除对象。 选项 "present" "absent"
switch_controller_location 字典	配置 FortiSwitch 位置服务。
address_civic 字典	配置位置民用地址。
additional 字符串	位置附加详细信息。
additional_code 字符串	位置附加代码详细信息。
block 字符串	位置街区详细信息。
branch_road 字符串	位置支路详细信息。
building 字符串	位置建筑物详细信息。
city 字符串	位置城市详细信息。
city_division 字符串	位置城市分区详细信息。
country 字符串	两位字母的 ISO 3166 国家代码，使用大写 ASCII 字母，例如 US、CA、DK、DE。
country_subdivision 字符串	国家细分（州、州、地区、省或省份）。
county 字符串	县、教区、枪支（JP）或地区（IN）。
direction 字符串	主要的街道方向。
floor 字符串	楼层。
landmark 字符串	地标或虚荣地址。
language 字符串	语言。
name 字符串	名称（住宅和办公室居住者）。
number 字符串	门牌号。
number_suffix 字符串	门牌号后缀。
parent_key 字符串	父键名称。
place_type 字符串	地点类型。
post_office_box 字符串	邮政信箱。
postal_community 字符串	邮政社区名称。
primary_road 字符串	主要道路名称。
road_section 字符串	路段。
room 字符串	房间号。
script 字符串	用于呈现地址信息的脚本。
seat 字符串	座位号。
street 字符串	街道。
street_name_post_mod 字符串	街道名称后修饰符。
street_name_pre_mod 字符串	街道名称前修饰符。
street_suffix 字符串	街道后缀。
sub_branch_road 字符串	子支路名称。
trailing_str_suffix 字符串	尾随街道后缀。
unit 字符串	单元（公寓，套房）。
zip 字符串	邮政编码。
coordinates 字典	配置位置 GPS 坐标。
altitude 字符串	正负浮点数。例如，117.47。
altitude_unit 字符串	配置海拔高度的单位（m = 米，f = 建筑物楼层）。 选项 "m" "f"
datum 字符串	WGS84、NAD83、NAD83/MLLW。 选项 "WGS84" "NAD83" "NAD83/MLLW"
latitude 字符串	以 +/- 开头或以 (N 或 S) 结尾的浮点数。例如，+/-16.67 或 16.67N。
longitude 字符串	以 +/- 开头或以 (N 或 S) 结尾的浮点数。例如，+/-26.789 或 26.789E。
parent_key 字符串	父键名称。
elin_number 字典	配置位置 ELIN 号码。
elin_num 字符串	配置 ELIN 回调号码。
parent_key 字符串	父键名称。
name 字符串 / 必需	唯一的地理位置项目名称。
vdom 字符串	虚拟域，属于先前定义的虚拟域。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。 默认值： "root"

注释

注意

• 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。

• 此模块支持 check_mode。

示例

- name: Configure FortiSwitch location services.
  fortinet.fortios.fortios_switch_controller_location:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_location:
          address_civic:
              additional: "<your_own_value>"
              additional_code: "<your_own_value>"
              block: "<your_own_value>"
              branch_road: "<your_own_value>"
              building: "<your_own_value>"
              city: "<your_own_value>"
              city_division: "<your_own_value>"
              country: "<your_own_value>"
              country_subdivision: "<your_own_value>"
              county: "<your_own_value>"
              direction: "<your_own_value>"
              floor: "<your_own_value>"
              landmark: "<your_own_value>"
              language: "<your_own_value>"
              name: "default_name_18"
              number: "<your_own_value>"
              number_suffix: "<your_own_value>"
              parent_key: "<your_own_value>"
              place_type: "<your_own_value>"
              post_office_box: "<your_own_value>"
              postal_community: "<your_own_value>"
              primary_road: "<your_own_value>"
              road_section: "<your_own_value>"
              room: "<your_own_value>"
              script: "<your_own_value>"
              seat: "<your_own_value>"
              street: "<your_own_value>"
              street_name_post_mod: "<your_own_value>"
              street_name_pre_mod: "<your_own_value>"
              street_suffix: "<your_own_value>"
              sub_branch_road: "<your_own_value>"
              trailing_str_suffix: "<your_own_value>"
              unit: "<your_own_value>"
              zip: "<your_own_value>"
          coordinates:
              altitude: "<your_own_value>"
              altitude_unit: "m"
              datum: "WGS84"
              latitude: "<your_own_value>"
              longitude: "<your_own_value>"
              parent_key: "<your_own_value>"
          elin_number:
              elin_num: "<your_own_value>"
              parent_key: "<your_own_value>"
          name: "default_name_48"

返回值

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

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

作者

• 郑链 (@chillancezen)

• 薛杰 (@JieX19)

• 陆洪宾 (@fgtdev-hblu)

• 沈方 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

资源链接

• 问题追踪器
• 主页
• 代码仓库