fortinet.fortios.fortios_switch_controller_location module – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_location.
New in fortinet.fortios 2.0.0
Synopsis
This 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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure FortiSwitch location services. |
|
Configure location civic address. |
|
Location additional details. |
|
Location additional code details. |
|
Location block details. |
|
Location branch road details. |
|
Location building details. |
|
Location city details. |
|
Location city division details. |
|
The two-letter ISO 3166 country code in capital ASCII letters eg. US, CA, DK, DE. |
|
National subdivisions (state, canton, region, province, or prefecture). |
|
County, parish, gun (JP), or district (IN). |
|
Leading street direction. |
|
Floor. |
|
Landmark or vanity address. |
|
Language. |
|
Name (residence and office occupant). |
|
House number. |
|
House number suffix. |
|
Parent key name. |
|
Place type. |
|
Post office box. |
|
Postal community name. |
|
Primary road name. |
|
Road section. |
|
Room number. |
|
Script used to present the address information. |
|
Seat number. |
|
Street. |
|
Street name post modifier. |
|
Street name pre modifier. |
|
Street suffix. |
|
Sub branch road name. |
|
Trailing street suffix. |
|
Unit (apartment, suite). |
|
Postal/zip code. |
|
Configure location GPS coordinates. |
|
Plus or minus floating point number. For example, 117.47. |
|
Configure the unit for which the altitude is to (m = meters, f = floors of a building). Choices:
|
|
WGS84, NAD83, NAD83/MLLW. Choices:
|
|
Floating point starting with +/- or ending with (N or S). For example, +/-16.67 or 16.67N. |
|
Floating point starting with +/- or ending with (N or S). For example, +/-26.789 or 26.789E. |
|
Parent key name. |
|
Configure location ELIN number. |
|
Configure ELIN callback number. |
|
Parent key name. |
|
Unique location item name. |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |