:source: fmgd_system_interface.py :orphan: .. _fmgd_system_interface: fmgd_system_interface -- Configure interfaces. ++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.0.0 .. 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: v7.2.6 -> v7.2.12, v7.4.3 -> 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 vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure interfaces. fortinet.fmgdevice.fmgd_system_interface: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: state: present # system_interface: name: "your value" # Required variable, string # ac_name: # aggregate: # aggregate_type: # algorithm: # alias: # allowaccess: # - "https" # - "ping" # - "ssh" # - "snmp" # - "http" # - "telnet" # - "fgfm" # - "auto-ipsec" # - "radius-acct" # - "probe-response" # - "capwap" # - "dnp" # - "ftm" # - "fabric" # - "speed-test" # - "icond" # - "scim" # annex: # ap_discover: # arpforward: # atm_protocol: # auth_cert: # auth_portal_addr: # auth_type: # auto_auth_extension_device: # bandwidth_measure_time: # bfd: # bfd_desired_min_tx: # bfd_detect_mult: # bfd_required_min_rx: # broadcast_forward: # captive_portal: # cli_conn_status: # client_options: # - code: # id: # ip: # type: # value: # color: # dedicated_to: # default_purdue_level: # defaultgw: # description: # detected_peer_mtu: # device_identification: # device_user_identification: # devindex: # dhcp_broadcast_flag: # dhcp_classless_route_addition: # dhcp_client_identifier: # dhcp_relay_agent_option: # dhcp_relay_allow_no_end_option: # dhcp_relay_circuit_id: # dhcp_relay_interface: # dhcp_relay_interface_select_method: # dhcp_relay_ip: # dhcp_relay_link_selection: # dhcp_relay_request_all_server: # dhcp_relay_service: # dhcp_relay_source_ip: # dhcp_relay_type: # dhcp_renew_time: # dhcp_smart_relay: # dhcp_snooping_server_list: # - name: # server_ip: # disc_retry_timeout: # distance: # dns_server_override: # dns_server_protocol: # - "cleartext" # - "dot" # - "doh" # drop_fragment: # drop_overlapped_fragment: # eap_ca_cert: # eap_identity: # eap_method: # eap_password: # eap_supplicant: # eap_user_cert: # egress_cos: # egress_queues: # cos0: # cos1: # cos2: # cos3: # cos4: # cos5: # cos6: # cos7: # egress_shaping_profile: # eip: # 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" # fortilink: # fortilink_backup_link: # fortilink_neighbor_detect: # fortilink_split_interface: # forward_domain: # forward_error_correction: # gateway_address: # gi_gk: # icmp_accept_redirect: # icmp_send_redirect: # ident_accept: # idle_timeout: # ike_saml_server: # inbandwidth: # ingress_cos: # ingress_shaping_profile: # ingress_spillover_threshold: # interconnect_profile: # interface: # internal: # ip: # ip_managed_by_fortiipam: # ipmac: # ips_sniffer_mode: # ipunnumbered: # ipv6: # autoconf: # cli_conn6_status: # dhcp6_client_options: # - "rapid" # - "iapd" # - "iana" # - "dns" # - "dnsname" # dhcp6_iapd_list: # - iaid: # prefix_hint: # prefix_hint_plt: # prefix_hint_vlt: # dhcp6_information_request: # dhcp6_prefix_delegation: # dhcp6_relay_interface_id: # dhcp6_relay_ip: # dhcp6_relay_service: # dhcp6_relay_source_interface: # dhcp6_relay_source_ip: # 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_iaid: # ip6_delegated_prefix_list: # - autonomous_flag: # delegated_prefix_iaid: # onlink_flag: # prefix_id: # rdnss: # rdnss_service: # subnet: # upstream_interface: # 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_prefix_mode: # 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: # ra_send_mtu: # unique_autoconf_addr: # vrip6_link_local: # vrrp_virtual_mac6: # vrrp6: # - accept_mode: # adv_interval: # ignore_default_route: # preempt: # priority: # start_time: # status: # vrdst6: # vrgrp: # vrid: # vrip6: # vrdst_priority: # dhcp6_prefix_hint_vlt: # dhcp6_prefix_hint: # dhcp6_prefix_hint_plt: # client_options: # - code: # id: # ip6: # type: # value: # ip6_adv_rio: # ip6_dnssl_list: # - dnssl_life_time: # domain: # ip6_rdnss_list: # - rdnss: # rdnss_life_time: # ip6_route_list: # - route: # route_life_time: # route_pref: # ip6_route_pref: # l2forward: # l2tp_client: # l2tp_client_settings: # auth_type: # defaultgw: # distance: # hello_interval: # ip: # mtu: # password: # peer_host: # peer_mask: # peer_port: # priority: # user: # lacp_ha_secondary: # lacp_mode: # lacp_speed: # lcp_echo_interval: # lcp_max_echo_fails: # link_up_delay: # lldp_network_policy: # lldp_reception: # lldp_transmission: # macaddr: # managed_subnetwork_size: # management_ip: # measured_downstream_bandwidth: # measured_upstream_bandwidth: # mediatype: # member: # min_links: # min_links_down: # mirroring_direction: # mirroring_filter: # dbg_dump: # filter_dport: # filter_dstip: # filter_protocol: # filter_sport: # filter_srcip: # mirroring_port: # mode: # monitor_bandwidth: # mtu: # mtu_override: # mux_type: # ndiscforward: # netbios_forward: # netflow_sampler: # np_qos_profile: # outbandwidth: # padt_retry_timeout: # password: # phy_mode: # poe: # polling_interval: # port_mirroring: # 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: # 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: # redundant_interface: # remote_ip: # replacemsg_override_group: # retransmission: # ring_rx: # ring_tx: # role: # sample_direction: # sample_rate: # 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" # id: # ip: # secip_relay_ip: # security_8021x_dynamic_vlan_id: # security_8021x_master: # security_8021x_member_mode: # security_8021x_mode: # security_exempt_list: # security_external_logout: # security_external_web: # security_groups: # security_mac_auth_bypass: # security_mode: # security_redirect_url: # select_profile_30a_35b: # service_name: # sflow_sampler: # sfp_dsl: # sfp_dsl_adsl_fallback: # sfp_dsl_autodetect: # sfp_dsl_mac: # snmp_index: # speed: # spillover_threshold: # src_check: # status: # stp: # stp_edge: # stp_ha_secondary: # stpforward: # stpforward_mode: # subst: # substitute_dst_mac: # sw_algorithm: # swc_first_create: # swc_vlan: # switch: # switch_controller_access_vlan: # switch_controller_arp_inspection: # switch_controller_dhcp_snooping: # switch_controller_dhcp_snooping_option82: # switch_controller_dhcp_snooping_verify_mac: # switch_controller_dynamic: # 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_netflow_collect: # switch_controller_offload: # switch_controller_offload_gw: # switch_controller_offload_ip: # switch_controller_rspan_mode: # switch_controller_source_ip: # switch_controller_traffic_policy: # system_id: # system_id_type: # tagging: # - category: # name: # tags: # 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: # vdom: # vectoring: # vindex: # vlan_id: # vlan_op_mode: # vlan_protocol: # vlanforward: # vlanid: # vpi: # vrf: # vrrp: # - accept_mode: # adv_interval: # ignore_default_route: # preempt: # priority: # proxy_arp: # - id: # ip: # start_time: # status: # version: # vrdst: # vrdst_priority: # vrgrp: # vrid: # vrip: # 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_dns_server1: # wifi_dns_server2: # wifi_encrypt: # wifi_fragment_threshold: # wifi_gateway: # wifi_key: # wifi_keyindex: # wifi_mac_filter: # wifi_networks: # - id: # obsolete_security_options: # wifi_ca_certificate: # wifi_client_certificate: # wifi_eap_type: # wifi_encrypt: # wifi_key: # wifi_keyindex: # wifi_passphrase: # wifi_private_key: # wifi_private_key_password: # wifi_security: # wifi_ssid: # wifi_username: # wifi_passphrase: # wifi_radius_server: # wifi_rts_threshold: # wifi_security: # wifi_ssid: # wifi_usergroup: # wins_ip: # lacp_ha_slave: # disconnect_threshold: # max_egress_rate: # max_egress_burst_rate: # stp_ha_slave: # fortilink_stacking: # broadcast_forticlient_discovery: # netflow_sample_rate: # netflow_sampler_id: # pppoe_egress_cos: # security_ip_auth_bypass: # virtual_mac: # dhcp_relay_vrf_select: # exclude_signatures: # - "iot" # - "ot" # phy_setting: # signal_ok_threshold_value: # signal_ok_threshold: # profiles: # - "8a" # - "8b" # - "8c" # - "8d" # - "12a" # - "12b" # - "17a" # - "30a" # - "35b" # telemetry_discover: # generic_receive_offload: # large_receive_offload: # scan_botnet_connections: # multilink: # mrru: 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)