Try SpotterConfigure FortiSwitch location services in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of lix_fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120
collections:
- name: lix_fortinet.fortios
version: 102.2.120This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and location category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure FortiSwitch location services.
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"
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
switch_controller_location:
default: null
description:
- Configure FortiSwitch location services.
suboptions:
address_civic:
description:
- Configure location civic address.
suboptions:
additional:
description:
- Location additional details.
type: str
additional_code:
description:
- Location additional code details.
type: str
block:
description:
- Location block details.
type: str
branch_road:
description:
- Location branch road details.
type: str
building:
description:
- Location building details.
type: str
city:
description:
- Location city details.
type: str
city_division:
description:
- Location city division details.
type: str
country:
description:
- The two-letter ISO 3166 country code in capital ASCII letters eg. US, CA,
DK, DE.
type: str
country_subdivision:
description:
- National subdivisions (state, canton, region, province, or prefecture).
type: str
county:
description:
- County, parish, gun (JP), or district (IN).
type: str
direction:
description:
- Leading street direction.
type: str
floor:
description:
- Floor.
type: str
landmark:
description:
- Landmark or vanity address.
type: str
language:
description:
- Language.
type: str
name:
description:
- Name (residence and office occupant).
type: str
number:
description:
- House number.
type: str
number_suffix:
description:
- House number suffix.
type: str
parent_key:
description:
- Parent key name.
type: str
place_type:
description:
- Place type.
type: str
post_office_box:
description:
- Post office box.
type: str
postal_community:
description:
- Postal community name.
type: str
primary_road:
description:
- Primary road name.
type: str
road_section:
description:
- Road section.
type: str
room:
description:
- Room number.
type: str
script:
description:
- Script used to present the address information.
type: str
seat:
description:
- Seat number.
type: str
street:
description:
- Street.
type: str
street_name_post_mod:
description:
- Street name post modifier.
type: str
street_name_pre_mod:
description:
- Street name pre modifier.
type: str
street_suffix:
description:
- Street suffix.
type: str
sub_branch_road:
description:
- Sub branch road name.
type: str
trailing_str_suffix:
description:
- Trailing street suffix.
type: str
unit:
description:
- Unit (apartment, suite).
type: str
zip:
description:
- Postal/zip code.
type: str
type: dict
coordinates:
description:
- Configure location GPS coordinates.
suboptions:
altitude:
description:
- Plus or minus floating point number. For example, 117.47.
type: str
altitude_unit:
choices:
- m
- f
description:
- Configure the unit for which the altitude is to (m = meters, f = floors
of a building).
type: str
datum:
choices:
- WGS84
- NAD83
- NAD83/MLLW
description:
- WGS84, NAD83, NAD83/MLLW.
type: str
latitude:
description:
- Floating point starting with +/- or ending with (N or S). For example, +/-16.67
or 16.67N.
type: str
longitude:
description:
- Floating point starting with +/- or ending with (N or S). For example, +/-26.789
or 26.789E.
type: str
parent_key:
description:
- Parent key name.
type: str
type: dict
elin_number:
description:
- Configure location ELIN number.
suboptions:
elin_num:
description:
- Configure ELIN callback number.
type: str
parent_key:
description:
- Parent key name.
type: str
type: dict
name:
description:
- Unique location item name.
required: true
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str