fortios_switch_controller_location – Configure FortiSwitch location services in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_switch_controller_location | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- 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 more...
- address_civic - Configure location civic address. type: dict more...
- additional - Location additional details. type: str more...
- additional_code - Location additional code details. type: str more...
- block - Location block details. type: str more...
- branch_road - Location branch road details. type: str more...
- building - Location building details. type: str more...
- city - Location city details. type: str more...
- city_division - Location city division details. type: str more...
- country - The two-letter ISO 3166 country code in capital ASCII letters eg. US, CA, DK, DE. type: str more...
- country_subdivision - National subdivisions (state, canton, region, province, or prefecture). type: str more...
- county - County, parish, gun (JP), or district (IN). type: str more...
- direction - Leading street direction. type: str more...
- floor - Floor. type: str more...
- landmark - Landmark or vanity address. type: str more...
- language - Language. type: str more...
- name - Name (residence and office occupant). type: str more...
- number - House number. type: str more...
- number_suffix - House number suffix. type: str more...
- parent_key - Parent key name. type: str more...
- place_type - Place type. type: str more...
- post_office_box - Post office box. type: str more...
- postal_community - Postal community name. type: str more...
- primary_road - Primary road name. type: str more...
- road_section - Road section. type: str more...
- room - Room number. type: str more...
- script - Script used to present the address information. type: str more...
- seat - Seat number. type: str more...
- street - Street. type: str more...
- street_name_post_mod - Street name post modifier. type: str more...
- street_name_pre_mod - Street name pre modifier. type: str more...
- street_suffix - Street suffix. type: str more...
- sub_branch_road - Sub branch road name. type: str more...
- trailing_str_suffix - Trailing street suffix. type: str more...
- unit - Unit (apartment, suite). type: str more...
- zip - Postal/zip code. type: str more...
- coordinates - Configure location GPS coordinates. type: dict more...
- altitude - Plus or minus floating point number. For example, 117.47. type: str more...
- altitude_unit - Configure the unit for which the altitude is to (m = meters, f = floors of a building). type: str choices: m, f more...
- datum - WGS84, NAD83, NAD83/MLLW. type: str choices: WGS84, NAD83, NAD83/MLLW more...
- latitude - Floating point starting with +/- or ending with (N or S). For example, +/-16.67 or 16.67N. type: str more...
- longitude - Floating point starting with +/- or ending with (N or S). For example, +/-26.789 or 26.789E. type: str more...
- parent_key - Parent key name. type: str more...
- elin_number - Configure location ELIN number. type: dict more...
- elin_num - Configure ELIN callback number. type: str more...
- parent_key - Parent key name. type: str more...
- name - Unique location item name. type: str required: true more...
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: 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