FortiSwitch Ansible Collection
The collection is the FortiSwitch Ansible Automation project. It includes the modules that are able to configure FortiSwitch.
Installation
This collection is distributed via ansible-galaxy, the installation steps are as follows:
- Install or upgrade to Ansible 2.11
- Download this collection from galaxy:
ansible-galaxy collection install fortinet.fortiswitch:1.2.4
Requirements
- Ansible 2.11 is required to support the newer Ansible Collections format
Supported FortiSwitch Versions
| FSW version | Galaxy Version | Release date | Path to Install |
|---|---|---|---|
| 7.0.0 | 1.0.0 | 2021/12/15 | ansible-galaxy collection install fortinet.fortiswitch:1.0.0 |
| 7.0.0 | 1.0.1 | 2022/2/2 | ansible-galaxy collection install fortinet.fortiswitch:1.0.1 |
| 7.0.0 | 1.1.0 latest |
2022/4/1 | ansible-galaxy collection install fortinet.fortiswitch:1.1.0 |
Note: Use -f option (i.e. ansible-galaxy collection install -f fortinet.fortiswitch:x.x.x) to renew your existing local installation.
Modules
The collection provides the following modules:
fortiswitch_alertemail_settingAlertemail setting configuration in Fortinet's FortiSwitchfortiswitch_configuration_factRetrieve Facts of FortiSwitch Configurable Objects.fortiswitch_execute_backup_default_configBackup Switch's Default Configuration.fortiswitch_execute_backup_full_configBackup Switch's Full Configuration.fortiswitch_execute_backup_standalone_configBackup Switch's Standalone Configuration.fortiswitch_execute_download_sniffer_profileDownload sniffer profile.fortiswitch_execute_sign_dataSign data with a local certificate.fortiswitch_export_config_playbookConvert the returned facts into a playbook.fortiswitch_gui_consoleDashboard CLI console configuration in Fortinet's FortiSwitchfortiswitch_log_custom_fieldCustom field configuation in Fortinet's FortiSwitchfortiswitch_log_disk_filterFilters for local disk logging in Fortinet's FortiSwitchfortiswitch_log_disk_settingSettings for local disk logging in Fortinet's FortiSwitchfortiswitch_log_eventfilterLog event filter configuration in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer2_filterFilters for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer2_settingSetting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer3_filterFilters for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer3_settingSetting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer_filterFilters for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer_override_filterOverride filters for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer_override_settingSetting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortianalyzer_settingSetting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_log_fortiguard_settingSettings for FortiGuard Analysis Service in Fortinet's FortiSwitchfortiswitch_log_guiLogging device to display in GUI in Fortinet's FortiSwitchfortiswitch_log_memory_filterFilters for memory buffer in Fortinet's FortiSwitchfortiswitch_log_memory_global_settingGlobal settings for memory log in Fortinet's FortiSwitchfortiswitch_log_memory_settingSettings for memory buffer in Fortinet's FortiSwitchfortiswitch_log_remote_settingSettings for remote logging in Fortinet's FortiSwitchfortiswitch_log_syslogd2_filterFilters for remote system server in Fortinet's FortiSwitchfortiswitch_log_syslogd2_settingSettings for remote syslog server in Fortinet's FortiSwitchfortiswitch_log_syslogd3_filterFilters for remote system server in Fortinet's FortiSwitchfortiswitch_log_syslogd3_settingSettings for remote syslog server in Fortinet's FortiSwitchfortiswitch_log_syslogd_filterFilters for remote system server in Fortinet's FortiSwitchfortiswitch_log_syslogd_override_filterOverride filters for remote system server in Fortinet's FortiSwitchfortiswitch_log_syslogd_override_settingSettings for remote syslog server in Fortinet's FortiSwitchfortiswitch_log_syslogd_settingSettings for remote syslog server in Fortinet's FortiSwitchfortiswitch_monitor_factRetrieve Facts of FortiSwitch Monitor Objects.fortiswitch_router_access_list6IPv6 access list configuration in Fortinet's FortiSwitchfortiswitch_router_access_listAccess list configuration in Fortinet's FortiSwitchfortiswitch_router_aspath_listAS path list configuration in Fortinet's FortiSwitchfortiswitch_router_auth_pathAuth-based routing configuration in Fortinet's FortiSwitchfortiswitch_router_bgpBGP configuration in Fortinet's FortiSwitchfortiswitch_router_community_listCommunity list configuration in Fortinet's FortiSwitchfortiswitch_router_gwdetectGwdetect in Fortinet's FortiSwitchfortiswitch_router_isisISIS configuration in Fortinet's FortiSwitchfortiswitch_router_key_chainKey-chain configuration in Fortinet's FortiSwitchfortiswitch_router_multicast_flowMulticast-flow configuration in Fortinet's FortiSwitchfortiswitch_router_multicastRouter multicast configuration in Fortinet's FortiSwitchfortiswitch_router_ospf6Router OSPF6 configuration in Fortinet's FortiSwitchfortiswitch_router_ospfOSPF configuration in Fortinet's FortiSwitchfortiswitch_router_policyPolicy routing configuration in Fortinet's FortiSwitchfortiswitch_router_prefix_list6IPv6 prefix list configuration in Fortinet's FortiSwitchfortiswitch_router_prefix_listPrefix list configuration in Fortinet's FortiSwitchfortiswitch_router_ripRIP configuration in Fortinet's FortiSwitchfortiswitch_router_ripngrouter ripng configuratio in Fortinet's FortiSwitchfortiswitch_router_route_mapRoute map configuration in Fortinet's FortiSwitchfortiswitch_router_settingSet rib settings in Fortinet's FortiSwitchfortiswitch_router_static6Ipv6 static routes configuration in Fortinet's FortiSwitchfortiswitch_router_staticIPv4 static routes configuration in Fortinet's FortiSwitchfortiswitch_router_vrfVRF configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_802_1x802-1X Radius Dynamic Ingress Policy configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_egressEgress Policy configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_ingressIngress Policy configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_policerPolicer configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_prelookupPrelookup Policy configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_service_customCustom service configuration in Fortinet's FortiSwitchfortiswitch_switch_acl_settingsConfigure access-control lists global settings on Switch in Fortinet's FortiSwitchfortiswitch_switch_auto_isl_port_groupAuto ISL port group in Fortinet's FortiSwitchfortiswitch_switch_auto_networkAuto network in Fortinet's FortiSwitchfortiswitch_switch_controller_globalSwitch-controller global configuration in Fortinet's FortiSwitchfortiswitch_switch_domainSwitch forwarding domains in Fortinet's FortiSwitchfortiswitch_switch_globalConfigure global settings in Fortinet's FortiSwitchfortiswitch_switch_igmp_snooping_globalsConfigure igmp-snooping on Switch in Fortinet's FortiSwitchfortiswitch_switch_interfaceUsable interfaces (trunks and ports) in Fortinet's FortiSwitchfortiswitch_switch_ip_mac_bindingIp-mac-binding table in Fortinet's FortiSwitchfortiswitch_switch_lldp_profileLLDP configuration profiles in Fortinet's FortiSwitchfortiswitch_switch_lldp_settingsGlobal LLDP configuration in Fortinet's FortiSwitchfortiswitch_switch_macsec_profileMACsec configuration profiles in Fortinet's FortiSwitchfortiswitch_switch_mirrorPacket mirror in Fortinet's FortiSwitchfortiswitch_switch_mld_snooping_globalsConfigure mld-snooping on Switch in Fortinet's FortiSwitchfortiswitch_switch_network_monitor_directedConfiguration of the static entries for network monitoring on the switch in Fortinet's FortiSwitchfortiswitch_switch_network_monitor_settingsGlobal configuration of network monitoring on the switch in Fortinet's FortiSwitchfortiswitch_switch_phy_modePHY configuration in Fortinet's FortiSwitchfortiswitch_switch_physical_portPhysical port specific configuration in Fortinet's FortiSwitchfortiswitch_switch_ptp_policyPTP policy configuration in Fortinet's FortiSwitchfortiswitch_switch_ptp_settingsGlobal PTP configuration in Fortinet's FortiSwitchfortiswitch_switch_qos_dot1p_mapQOS 802.1p configuration in Fortinet's FortiSwitchfortiswitch_switch_qos_ip_dscp_mapQOS IP precedence/DSCP configuration in Fortinet's FortiSwitchfortiswitch_switch_qos_qos_policyQOS egress policy in Fortinet's FortiSwitchfortiswitch_switch_quarantineConfigure quarantine devices on the switch in Fortinet's FortiSwitchfortiswitch_switch_raguard_policyIPV6 RA Guard policy in Fortinet's FortiSwitchfortiswitch_switch_security_featureSwitch security feature control nobs in Fortinet's FortiSwitchfortiswitch_switch_static_macSwitch static mac address entries in Fortinet's FortiSwitchfortiswitch_switch_storm_controlConfigure excess switch traffic (storm control) in Fortinet's FortiSwitchfortiswitch_switch_stp_instanceStp instances in Fortinet's FortiSwitchfortiswitch_switch_stp_settingsSwitch-global stp settings in Fortinet's FortiSwitchfortiswitch_switch_trunkLink-aggregation in Fortinet's FortiSwitchfortiswitch_switch_virtual_wireConfigure virtual wire in Fortinet's FortiSwitchfortiswitch_switch_vlan_tpidConfigure switch global ether-types in Fortinet's FortiSwitchfortiswitch_switch_vlanConfigure optional per-VLAN settings in Fortinet's FortiSwitchfortiswitch_system_accprofileConfigure system administrative access group in Fortinet's FortiSwitchfortiswitch_system_adminAdministrative user configuration in Fortinet's FortiSwitchfortiswitch_system_alarmAlarm configuration in Fortinet's FortiSwitchfortiswitch_system_alertemailAlert e-mail mail server configuration in Fortinet's FortiSwitchfortiswitch_system_alias_commandAlias command definitions in Fortinet's FortiSwitchfortiswitch_system_alias_groupGroups of alias commands in Fortinet's FortiSwitchfortiswitch_system_arp_tableConfigure arp table in Fortinet's FortiSwitchfortiswitch_system_auto_scriptConfigure auto script in Fortinet's FortiSwitchfortiswitch_system_automation_actionAction for automation stitches in Fortinet's FortiSwitchfortiswitch_system_automation_destinationAutomation destinations in Fortinet's FortiSwitchfortiswitch_system_automation_stitchAutomation stitches in Fortinet's FortiSwitchfortiswitch_system_automation_triggerTrigger for automation stitches in Fortinet's FortiSwitchfortiswitch_system_autoupdate_clientoverrideConfigure client override for the FDN in Fortinet's FortiSwitchfortiswitch_system_autoupdate_overrideConfigure override FDS server in Fortinet's FortiSwitchfortiswitch_system_autoupdate_push_updateConfigure push updates in Fortinet's FortiSwitchfortiswitch_system_autoupdate_scheduleConfigure update schedule in Fortinet's FortiSwitchfortiswitch_system_autoupdate_tunnelingConfigure web proxy tunneling for the FDN in Fortinet's FortiSwitchfortiswitch_system_bug_reportConfigure bug report in Fortinet's FortiSwitchfortiswitch_system_central_managementCentral management configuration in Fortinet's FortiSwitchfortiswitch_system_certificate_caCA certificate in Fortinet's FortiSwitchfortiswitch_system_certificate_crlCertificate Revokation List in Fortinet's FortiSwitchfortiswitch_system_certificate_localLocal keys and certificates in Fortinet's FortiSwitchfortiswitch_system_certificate_ocspOcsp configuration in Fortinet's FortiSwitchfortiswitch_system_certificate_remoteRemote certificate in Fortinet's FortiSwitchfortiswitch_system_consoleConfigure console in Fortinet's FortiSwitchfortiswitch_system_dhcp_serverConfigure DHCP servers in Fortinet's FortiSwitchfortiswitch_system_dns_databaseDns-database in Fortinet's FortiSwitchfortiswitch_system_dns_serverDns-server in Fortinet's FortiSwitchfortiswitch_system_dnsConfigure DNS in Fortinet's FortiSwitchfortiswitch_system_email_serverEmail server configuration in Fortinet's FortiSwitchfortiswitch_system_flan_cloudFortiLAN cloud manager configuration in Fortinet's FortiSwitchfortiswitch_system_flow_exportSystem Flow Export settings in Fortinet's FortiSwitchfortiswitch_system_fmFm in Fortinet's FortiSwitchfortiswitch_system_fortianalyzer2Setting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_system_fortianalyzer3Setting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_system_fortianalyzerSetting for FortiAnalyzer in Fortinet's FortiSwitchfortiswitch_system_fortiguardConfigure FortiGuard services in Fortinet's FortiSwitchfortiswitch_system_fortimanagerFortiManagerconfiguration in Fortinet's FortiSwitchfortiswitch_system_fsw_cloudFortiSwitch cloud manager configuration in Fortinet's FortiSwitchfortiswitch_system_globalConfigure global range attributes in Fortinet's FortiSwitchfortiswitch_system_interfaceConfigure interfaces in Fortinet's FortiSwitchfortiswitch_system_ipv6_neighbor_cacheConfigure IPv6 neighbor cache table in Fortinet's FortiSwitchfortiswitch_system_link_monitorConfigure Link Health Monitor in Fortinet's FortiSwitchfortiswitch_system_locationConfigure Location table in Fortinet's FortiSwitchfortiswitch_system_mac_address_tableMac address table in Fortinet's FortiSwitchfortiswitch_system_management_tunnelManagement tunnel configuration in Fortinet's FortiSwitchfortiswitch_system_ntpNtp system info configuration in Fortinet's FortiSwitchfortiswitch_system_object_tagObject tags in Fortinet's FortiSwitchfortiswitch_system_password_policyConfig password policy in Fortinet's FortiSwitchfortiswitch_system_port_pairPort-pair in Fortinet's FortiSwitchfortiswitch_system_proxy_arpConfigure proxy-arp in Fortinet's FortiSwitchfortiswitch_system_ptp_interface_policyPTP policy configuration in Fortinet's FortiSwitchfortiswitch_system_ptp_profilePTP policy configuration in Fortinet's FortiSwitchfortiswitch_system_resource_limitsResource limits configuration in Fortinet's FortiSwitchfortiswitch_system_schedule_groupSchedule group configuration in Fortinet's FortiSwitchfortiswitch_system_schedule_onetimeonetime schedule configuratio in Fortinet's FortiSwitchfortiswitch_system_schedule_recurringrecurring schedule configuratio in Fortinet's FortiSwitchfortiswitch_system_session_ttlSession ttl configuration in Fortinet's FortiSwitchfortiswitch_system_settingsSettings in Fortinet's FortiSwitchfortiswitch_system_sflowConfigure sFlow in Fortinet's FortiSwitchfortiswitch_system_sniffer_profileShow packet sniffer configuration in Fortinet's FortiSwitchfortiswitch_system_snmp_communitySNMP community configuration in Fortinet's FortiSwitchfortiswitch_system_snmp_sysinfoSNMP system info configuration in Fortinet's FortiSwitchfortiswitch_system_snmp_userSNMP user configuration in Fortinet's FortiSwitchfortiswitch_system_tos_based_priorityConfigure tos based priority table in Fortinet's FortiSwitchfortiswitch_system_vdom_dnsVdom dns configuration in Fortinet's FortiSwitchfortiswitch_system_vdom_propertyVdom-property configuration in Fortinet's FortiSwitchfortiswitch_system_vdomVirtual domain configuration in Fortinet's FortiSwitchfortiswitch_system_vxlanConfigure VXLAN devices in Fortinet's FortiSwitchfortiswitch_system_webConfigure web attributes in Fortinet's FortiSwitchfortiswitch_system_zoneZone configuration in Fortinet's FortiSwitchfortiswitch_user_groupUser group configuration in Fortinet's FortiSwitchfortiswitch_user_ldapLDAP server entry configuration in Fortinet's FortiSwitchfortiswitch_user_localLocal user configuration in Fortinet's FortiSwitchfortiswitch_user_peerconfig peer use in Fortinet's FortiSwitchfortiswitch_user_peergrpconfig peer's user grou in Fortinet's FortiSwitchfortiswitch_user_radiusRADIUS server entry configuration in Fortinet's FortiSwitchfortiswitch_user_settingUser authentication setting in Fortinet's FortiSwitchfortiswitch_user_tacacsplusTACACS+ server entry configuration in Fortinet's FortiSwitch
Roles
Usage
The following example is used to configure system interface in Fortinet's FortiSwitch.
Create config_system_interface.yml with the following template:
---
- hosts: fortiswitch01
collections:
- fortinet.fortiswitch
connection: httpapi
gather_facts: 'no'
vars:
ansible_httpapi_use_ssl: 'yes'
ansible_httpapi_validate_certs: 'no'
ansible_httpapi_port: 443
tasks:
- name: edit internal interface
fortiswitch_system_interface:
state: present
system_interface:
name: internal
vdom: root
allowaccess: httpsCreate the hosts inventory file
[fortiswitches]
fortiswitch01 ansible_host=192.168.190.100 ansible_user="admin" ansible_password="password"
[fortiswitches:vars]
ansible_network_os=fortinet.fortiswitch.fortiswitchRun the test:
ansible-playbook -i hosts config_system_interface.ymlThe task will set up the allowaccess in system_interface.