fortios_system_virtual_switch – Configure virtual hardware switch interfaces 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 system feature and virtual_switch 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.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
|
fortios_system_virtual_switch | 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
- system_virtual_switch - Configure virtual hardware switch interfaces. type: dict more...
- name - Name of the virtual switch. type: str required: true more...
- physical_switch - Physical switch parent. Source system.physical-switch.name. type: str more...
- port - Configure member ports. type: list more...
- alias - Alias. type: str more...
- mediatype - Select SFP media interface type. type: str choices: cfp2-sr10, cfp2-lr4 more...
- name - Physical interface name. Source system.interface.name. type: str more...
- speed - Interface speed. type: str choices: auto, 10full, 10half, 100full, 100half, 1000full, 1000half, 1000auto, 10000full, 10000auto, 40000full, 100Gfull more...
- status - Interface status. type: str choices: up, down more...
- span - Enable/disable SPAN. type: str choices: disable, enable more...
- span_dest_port - SPAN destination port. type: str more...
- span_direction - SPAN direction. type: str choices: rx, tx, both more...
- span_source_port - SPAN source port. type: str 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 virtual hardware switch interfaces.
fortios_system_virtual_switch:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_virtual_switch:
name: "default_name_3"
physical_switch: "<your_own_value> (source system.physical-switch.name)"
port:
-
alias: "<your_own_value>"
mediatype: "cfp2-sr10"
name: "default_name_8 (source system.interface.name)"
speed: "auto"
status: "up"
span: "disable"
span_dest_port: "<your_own_value>"
span_direction: "rx"
span_source_port: "<your_own_value>"
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