fortios_switch_controller_location – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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.4.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- switch_controller_location - Configure FortiSwitch location services. type: dict
- address_civic - Configure location civic address. type: dict
- additional - Location additional details. type: str
- additional_code - Location additional code details. type: str
- block - Location block details. type: str
- branch_road - Location branch road details. type: str
- building - Location building details. type: str
- city - Location city details. type: str
- city_division - Location city division details. type: str
- country - The two-letter ISO 3166 country code in capital ASCII letters eg. US, CA, DK, DE. type: str
- country_subdivision - National subdivisions (state, canton, region, province, or prefecture). type: str
- county - County, parish, gun (JP), or district (IN). type: str
- direction - Leading street direction. type: str
- floor - Floor. type: str
- landmark - Landmark or vanity address. type: str
- language - Language. type: str
- name - Name (residence and office occupant). type: str
- number - House number. type: str
- number_suffix - House number suffix. type: str
- place_type - Placetype. type: str
- post_office_box - Post office box (P.O. box). type: str
- postal_community - Postal community name. type: str
- primary_road - Primary road name. type: str
- road_section - Road section. type: str
- room - Room number. type: str
- script - Script used to present the address information. type: str
- seat - Seat number. type: str
- street - Street. type: str
- street_name_post_mod - Street name post modifier. type: str
- street_name_pre_mod - Street name pre modifier. type: str
- street_suffix - Street suffix. type: str
- sub_branch_road - Sub branch road name. type: str
- trailing_str_suffix - Trailing street suffix. type: str
- unit - Unit (apartment, suite). type: str
- zip - Postal/zip code. type: str
- coordinates - Configure location GPS coordinates. type: dict
- altitude - +/- Floating point no. eg. 117.47. type: str
- altitude_unit - m ( meters), f ( floors). type: str choices: m, f
- datum - WGS84, NAD83, NAD83/MLLW. type: str choices: WGS84, NAD83, NAD83/MLLW
- latitude - Floating point start with ( +/- ) or end with ( N or S ) eg. +/-16.67 or 16.67N. type: str
- longitude - Floating point start with ( +/- ) or end with ( E or W ) eg. +/-26.789 or 26.789E. type: str
- elin_number - Configure location ELIN number. type: dict
- elin_num - Configure ELIN callback number. type: str
- name - Unique location item name. type: str required: True
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>"
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>"
elin_number:
elin_num: "<your_own_value>"
name: "default_name_45"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3