:source: fmgr_fsp_vlan.py :orphan: .. _fmgr_fsp_vlan: fmgr_fsp_vlan -- FortiSwitch VLAN template. +++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. warning:: Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case). - Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name`` - New argument name starting in 3.0.0: ``var_name`` FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg. .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiManager device. - Examples include all parameters and values need to be adjusted to data sources before usage. - Tested with FortiManager v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v6.0.0 -> latest

Parameters ---------- .. raw:: html Notes ----- .. note:: - Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work. - To create or update an object, use state: present directive. - To delete an object, use state: absent directive - Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded Examples -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false tasks: - name: FortiSwitch VLAN template. fortinet.fortimanager.fmgr_fsp_vlan: # workspace_locking_adom: adom: state: present # fsp_vlan: name: "your value" # Required variable, string # _dhcp_status: # auth: # color: # comments: # dynamic_mapping: # - _dhcp_status: # _scope: # - name: # vdom: # dhcp_server: # auto_configuration: # auto_managed_status: # conflicted_ip_timeout: # ddns_auth: # ddns_key: # ddns_keyname: # ddns_server_ip: # ddns_ttl: # ddns_update: # ddns_update_override: # ddns_zone: # default_gateway: # dhcp_settings_from_fortiipam: # dns_server1: # dns_server2: # dns_server3: # dns_server4: # dns_service: # domain: # enable: # exclude_range: # - end_ip: # id: # start_ip: # vci_match: # vci_string: # lease_time: # uci_match: # uci_string: # filename: # forticlient_on_net_status: # id: # ip_mode: # ip_range: # - end_ip: # id: # start_ip: # vci_match: # vci_string: # lease_time: # uci_match: # uci_string: # ipsec_lease_hold: # lease_time: # mac_acl_default_action: # netmask: # next_server: # ntp_server1: # ntp_server2: # ntp_server3: # ntp_service: # option1: # option2: # option3: # option4: # option5: # option6: # options: # - code: # id: # ip: # type: # value: # vci_match: # vci_string: # uci_match: # uci_string: # reserved_address: # - action: # circuit_id: # circuit_id_type: # description: # id: # ip: # mac: # remote_id: # remote_id_type: # type: # server_type: # status: # tftp_server: # timezone: # timezone_option: # vci_match: # vci_string: # wifi_ac_service: # wifi_ac1: # wifi_ac2: # wifi_ac3: # wins_server1: # wins_server2: # relay_agent: # shared_subnet: # interface: # dhcp_relay_agent_option: # dhcp_relay_ip: # dhcp_relay_service: # dhcp_relay_type: # ip: # ipv6: # autoconf: # dhcp6_client_options: ["rapid", "iapd", "iana", "dns", "dnsname"] # dhcp6_information_request: # dhcp6_prefix_delegation: # dhcp6_prefix_hint: # dhcp6_prefix_hint_plt: # dhcp6_prefix_hint_vlt: # dhcp6_relay_ip: # dhcp6_relay_service: # dhcp6_relay_type: # icmp6_send_redirect: # interface_identifier: # ip6_address: # ip6_allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "capwap", "fabric", "scim", "probe-response"] # ip6_default_life: # ip6_delegated_prefix_list: # - autonomous_flag: # onlink_flag: # prefix_id: # rdnss: # rdnss_service: # subnet: # upstream_interface: # delegated_prefix_iaid: # dnssl_service: # ip6_dns_server_override: # ip6_extra_addr: # - prefix: # ip6_hop_limit: # ip6_link_mtu: # ip6_manage_flag: # ip6_max_interval: # ip6_min_interval: # ip6_mode: # ip6_other_flag: # ip6_prefix_list: # - autonomous_flag: # dnssl: # onlink_flag: # preferred_life_time: # prefix: # rdnss: # valid_life_time: # ip6_reachable_time: # ip6_retrans_time: # ip6_send_adv: # ip6_subnet: # ip6_upstream_interface: # nd_cert: # nd_cga_modifier: # nd_mode: # nd_security_level: # nd_timestamp_delta: # nd_timestamp_fuzz: # unique_autoconf_addr: # vrip6_link_local: # vrrp_virtual_mac6: # vrrp6: # - accept_mode: # adv_interval: # preempt: # priority: # start_time: # status: # vrdst6: # vrgrp: # vrid: # vrip6: # ignore_default_route: # vrdst_priority: # cli_conn6_status: # ip6_prefix_mode: # ra_send_mtu: # ip6_delegated_prefix_iaid: # dhcp6_relay_source_interface: # dhcp6_relay_interface_id: # dhcp6_relay_source_ip: # ip6_adv_rio: # ip6_route_pref: # secondary_IP: # secondaryip: # - allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "auto-ipsec", "radius-acct", "probe-response", "capwap", # "dnp", "ftm", "fabric", "speed-test", "icond", "scim"] # detectprotocol: ["ping", "tcp-echo", "udp-echo"] # detectserver: # gwdetect: # ha_priority: # id: # ip: # ping_serv_status: # seq: # secip_relay_ip: # vlanid: # dhcp_relay_interface_select_method: # vrrp: # - accept_mode: # adv_interval: # ignore_default_route: # preempt: # priority: # proxy_arp: # - id: # ip: # start_time: # status: # version: # vrdst: # vrdst_priority: # vrgrp: # vrid: # vrip: # allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "radius-acct", "probe-response", "dnp", "ftm", "fabric", # "speed-test", "icond", "scim"] # dhcp_relay_request_all_server: # portal_message_override_group: # radius_server: # security: # selected_usergroups: # usergroup: # vdom: # vlanid: # dhcp_server: # auto_configuration: # auto_managed_status: # conflicted_ip_timeout: # ddns_auth: # ddns_key: # ddns_keyname: # ddns_server_ip: # ddns_ttl: # ddns_update: # ddns_update_override: # ddns_zone: # default_gateway: # dhcp_settings_from_fortiipam: # dns_server1: # dns_server2: # dns_server3: # dns_server4: # dns_service: # domain: # enable: # exclude_range: # - end_ip: # id: # start_ip: # vci_match: # vci_string: # lease_time: # uci_match: # uci_string: # filename: # forticlient_on_net_status: # id: # ip_mode: # ip_range: # - end_ip: # id: # start_ip: # vci_match: # vci_string: # lease_time: # uci_match: # uci_string: # ipsec_lease_hold: # lease_time: # mac_acl_default_action: # netmask: # next_server: # ntp_server1: # ntp_server2: # ntp_server3: # ntp_service: # option1: # option2: # option3: # option4: # option5: # option6: # options: # - code: # id: # ip: # type: # value: # vci_match: # vci_string: # uci_match: # uci_string: # reserved_address: # - action: # circuit_id: # circuit_id_type: # description: # id: # ip: # mac: # remote_id: # remote_id_type: # type: # server_type: # status: # tftp_server: # timezone: # timezone_option: # vci_match: # vci_string: # wifi_ac_service: # wifi_ac1: # wifi_ac2: # wifi_ac3: # wins_server1: # wins_server2: # relay_agent: # shared_subnet: # interface: # ac_name: # aggregate: # algorithm: # alias: # allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "auto-ipsec", "radius-acct", "probe-response", "capwap", "dnp", "ftm", # "fabric", "speed-test"] # ap_discover: # arpforward: # atm_protocol: # auth_type: # auto_auth_extension_device: # bandwidth_measure_time: # bfd: # bfd_desired_min_tx: # bfd_detect_mult: # bfd_required_min_rx: # broadcast_forticlient_discovery: # broadcast_forward: # captive_portal: # cli_conn_status: # color: # ddns: # ddns_auth: # ddns_domain: # ddns_key: # ddns_keyname: # ddns_password: # ddns_server: # ddns_server_ip: # ddns_sn: # ddns_ttl: # ddns_username: # ddns_zone: # dedicated_to: # defaultgw: # description: # detected_peer_mtu: # detectprotocol: ["ping", "tcp-echo", "udp-echo"] # detectserver: # device_access_list: # device_identification: # device_identification_active_scan: # device_netscan: # device_user_identification: # devindex: # dhcp_client_identifier: # dhcp_relay_agent_option: # dhcp_relay_interface: # dhcp_relay_interface_select_method: # dhcp_relay_ip: # dhcp_relay_service: # dhcp_relay_type: # dhcp_renew_time: # disc_retry_timeout: # disconnect_threshold: # distance: # dns_query: # dns_server_override: # drop_fragment: # drop_overlapped_fragment: # egress_cos: # egress_shaping_profile: # eip: # endpoint_compliance: # estimated_downstream_bandwidth: # estimated_upstream_bandwidth: # explicit_ftp_proxy: # explicit_web_proxy: # external: # fail_action_on_extender: # fail_alert_interfaces: # fail_alert_method: # fail_detect: # fail_detect_option: ["detectserver", "link-down"] # fdp: # fortiheartbeat: # fortilink: # fortilink_backup_link: # fortilink_neighbor_detect: # fortilink_split_interface: # fortilink_stacking: # forward_domain: # forward_error_correction: # fp_anomaly: ["drop_tcp_fin_noack", "pass_winnuke", "pass_tcpland", "pass_udpland", # "pass_icmpland", "pass_ipland", "pass_iprr", "pass_ipssrr", # "pass_iplsrr", "pass_ipstream", "pass_ipsecurity", "pass_iptimestamp", # "pass_ipunknown_option", "pass_ipunknown_prot", "pass_icmp_frag", # "pass_tcp_no_flag", "pass_tcp_fin_noack", "drop_winnuke", # "drop_tcpland", "drop_udpland", "drop_icmpland", "drop_ipland", # "drop_iprr", "drop_ipssrr", "drop_iplsrr", "drop_ipstream", # "drop_ipsecurity", "drop_iptimestamp", "drop_ipunknown_option", # "drop_ipunknown_prot", "drop_icmp_frag", "drop_tcp_no_flag"] # fp_disable: ["all", "ipsec", "none"] # gateway_address: # gi_gk: # gwaddr: # gwdetect: # ha_priority: # icmp_accept_redirect: # icmp_redirect: # icmp_send_redirect: # ident_accept: # idle_timeout: # if_mdix: # if_media: # in_force_vlan_cos: # inbandwidth: # ingress_cos: # ingress_shaping_profile: # ingress_spillover_threshold: # internal: # ip: # ip_managed_by_fortiipam: # ipmac: # ips_sniffer_mode: # ipunnumbered: # ipv6: # autoconf: # dhcp6_client_options: ["rapid", "iapd", "iana", "dns", "dnsname"] # dhcp6_information_request: # dhcp6_prefix_delegation: # dhcp6_prefix_hint: # dhcp6_prefix_hint_plt: # dhcp6_prefix_hint_vlt: # dhcp6_relay_ip: # dhcp6_relay_service: # dhcp6_relay_type: # icmp6_send_redirect: # interface_identifier: # ip6_address: # ip6_allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "capwap", "fabric"] # ip6_default_life: # ip6_delegated_prefix_list: # - autonomous_flag: # onlink_flag: # prefix_id: # rdnss: # rdnss_service: # subnet: # upstream_interface: # delegated_prefix_iaid: # dnssl_service: # ip6_dns_server_override: # ip6_extra_addr: # - prefix: # ip6_hop_limit: # ip6_link_mtu: # ip6_manage_flag: # ip6_max_interval: # ip6_min_interval: # ip6_mode: # ip6_other_flag: # ip6_prefix_list: # - autonomous_flag: # dnssl: # onlink_flag: # preferred_life_time: # prefix: # rdnss: # valid_life_time: # ip6_reachable_time: # ip6_retrans_time: # ip6_send_adv: # ip6_subnet: # ip6_upstream_interface: # nd_cert: # nd_cga_modifier: # nd_mode: # nd_security_level: # nd_timestamp_delta: # nd_timestamp_fuzz: # unique_autoconf_addr: # vrip6_link_local: # vrrp_virtual_mac6: # vrrp6: # - accept_mode: # adv_interval: # preempt: # priority: # start_time: # status: # vrdst6: # vrgrp: # vrid: # vrip6: # ignore_default_route: # vrdst_priority: # cli_conn6_status: # ip6_prefix_mode: # ra_send_mtu: # ip6_delegated_prefix_iaid: # dhcp6_relay_source_interface: # dhcp6_relay_interface_id: # dhcp6_relay_source_ip: # ip6_adv_rio: # ip6_route_pref: # l2forward: # l2tp_client: # lacp_ha_slave: # lacp_mode: # lacp_speed: # lcp_echo_interval: # lcp_max_echo_fails: # link_up_delay: # listen_forticlient_connection: # lldp_network_policy: # lldp_reception: # lldp_transmission: # log: # macaddr: # managed_subnetwork_size: # management_ip: # max_egress_burst_rate: # max_egress_rate: # measured_downstream_bandwidth: # measured_upstream_bandwidth: # mediatype: # member: # min_links: # min_links_down: # mode: # monitor_bandwidth: # mtu: # mtu_override: # mux_type: # name: # ndiscforward: # netbios_forward: # netflow_sampler: # np_qos_profile: # npu_fastpath: # nst: # out_force_vlan_cos: # outbandwidth: # padt_retry_timeout: # password: # peer_interface: # phy_mode: # ping_serv_status: # poe: # polling_interval: # pppoe_unnumbered_negotiate: # pptp_auth_type: # pptp_client: # pptp_password: # pptp_server_ip: # pptp_timeout: # pptp_user: # preserve_session_route: # priority: # priority_override: # proxy_captive_portal: # redundant_interface: # remote_ip: # replacemsg_override_group: # retransmission: # ring_rx: # ring_tx: # role: # sample_direction: # sample_rate: # scan_botnet_connections: # secondary_IP: # secondaryip: # - allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", # "auto-ipsec", "radius-acct", "probe-response", "capwap", "dnp", # "ftm", "fabric", "speed-test", "icond", "scim"] # detectprotocol: ["ping", "tcp-echo", "udp-echo"] # detectserver: # gwdetect: # ha_priority: # id: # ip: # ping_serv_status: # seq: # secip_relay_ip: # security_8021x_dynamic_vlan_id: # security_8021x_master: # security_8021x_mode: # security_exempt_list: # security_external_logout: # security_external_web: # security_groups: # security_mac_auth_bypass: # security_mode: # security_redirect_url: # service_name: # sflow_sampler: # speed: # spillover_threshold: # src_check: # status: # stp: # stp_ha_slave: # stpforward: # stpforward_mode: # strip_priority_vlan_tag: # subst: # substitute_dst_mac: # swc_first_create: # swc_vlan: # switch: # switch_controller_access_vlan: # switch_controller_arp_inspection: # switch_controller_auth: # switch_controller_dhcp_snooping: # switch_controller_dhcp_snooping_option82: # switch_controller_dhcp_snooping_verify_mac: # switch_controller_feature: # switch_controller_igmp_snooping: # switch_controller_igmp_snooping_fast_leave: # switch_controller_igmp_snooping_proxy: # switch_controller_iot_scanning: # switch_controller_learning_limit: # switch_controller_mgmt_vlan: # switch_controller_nac: # switch_controller_radius_server: # switch_controller_rspan_mode: # switch_controller_source_ip: # switch_controller_traffic_policy: # tc_mode: # tcp_mss: # trunk: # trust_ip_1: # trust_ip_2: # trust_ip_3: # trust_ip6_1: # trust_ip6_2: # trust_ip6_3: # type: # username: # vci: # vectoring: # vindex: # vlan_protocol: # vlanforward: # vlanid: # vpi: # vrf: # vrrp: # - accept_mode: # adv_interval: # ignore_default_route: # preempt: # priority: # start_time: # status: # version: # vrdst: # vrdst_priority: # vrgrp: # vrid: # vrip: # proxy_arp: # - id: # ip: # vrrp_virtual_mac: # wccp: # weight: # wifi_5g_threshold: # wifi_acl: # wifi_ap_band: # wifi_auth: # wifi_auto_connect: # wifi_auto_save: # wifi_broadcast_ssid: # wifi_encrypt: # wifi_fragment_threshold: # wifi_key: # wifi_keyindex: # wifi_mac_filter: # wifi_passphrase: # wifi_radius_server: # wifi_rts_threshold: # wifi_security: # wifi_ssid: # wifi_usergroup: # wins_ip: # dhcp_relay_request_all_server: # stp_ha_secondary: # switch_controller_dynamic: # auth_cert: # auth_portal_addr: # dhcp_classless_route_addition: # dhcp_relay_link_selection: # dns_server_protocol: ["cleartext", "dot", "doh"] # eap_ca_cert: # eap_identity: # eap_method: # eap_password: # eap_supplicant: # eap_user_cert: # ike_saml_server: # lacp_ha_secondary: # pvc_atm_qos: # pvc_chan: # pvc_crc: # pvc_pcr: # pvc_scr: # pvc_vlan_id: # pvc_vlan_rx_id: # pvc_vlan_rx_op: # pvc_vlan_tx_id: # pvc_vlan_tx_op: # reachable_time: # select_profile_30a_35b: # sfp_dsl: # sfp_dsl_adsl_fallback: # sfp_dsl_autodetect: # sfp_dsl_mac: # sw_algorithm: # system_id: # system_id_type: # vlan_id: # vlan_op_mode: # generic_receive_offload: # interconnect_profile: # large_receive_offload: # annex: # aggregate_type: # switch_controller_netflow_collect: # wifi_dns_server1: # wifi_dns_server2: # wifi_gateway: # default_purdue_level: # dhcp_broadcast_flag: # dhcp_smart_relay: # switch_controller_offloading: # switch_controller_offloading_gw: # switch_controller_offloading_ip: # dhcp_relay_circuit_id: # dhcp_relay_source_ip: # switch_controller_offload: # switch_controller_offload_gw: # switch_controller_offload_ip: # mirroring_direction: # mirroring_port: # port_mirroring: # security_8021x_member_mode: # stp_edge: # dhcp_relay_allow_no_end_option: # netflow_sample_rate: # netflow_sampler_id: # pppoe_egress_cos: # security_ip_auth_bypass: # virtual_mac: # dhcp_relay_vrf_select: # exclude_signatures: ["iot", "ot"] # profiles: ["8a", "8b", "8c", "8d", "12a", "12b", "17a", "30a", "35b"] # telemetry_discover: # mrru: # multilink: 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: .. raw:: html
  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu)