:source: fmgr_switchcontroller_managedswitch.py :orphan: .. _fmgr_switchcontroller_managedswitch: fmgr_switchcontroller_managedswitch -- Configure FortiSwitch devices that are managed by this FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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: Configure FortiSwitch devices that are managed by this FortiGate. fortinet.fortimanager.fmgr_switchcontroller_managedswitch: # workspace_locking_adom: adom: state: present # switchcontroller_managedswitch: switch_id: "your value" # Required variable, string # _platform: # description: # name: # ports: # - allowed_vlans: # allowed_vlans_all: # arp_inspection_trust: # bundle: # description: # dhcp_snoop_option82_trust: # dhcp_snooping: # discard_mode: # edge_port: # igmp_snooping: # igmps_flood_reports: # igmps_flood_traffic: # lacp_speed: # learning_limit: # lldp_profile: # lldp_status: # loop_guard: # loop_guard_timeout: # max_bundle: # mclag: # member_withdrawal_behavior: # members: # min_bundle: # mode: # poe_pre_standard_detection: # poe_status: # port_name: # port_owner: # port_security_policy: # port_selection_criteria: # qos_policy: # sample_direction: # sflow_counter_interval: # sflow_sample_rate: # sflow_sampler: # stp_bpdu_guard: # stp_bpdu_guard_timeout: # stp_root_guard: # stp_state: # type: # untagged_vlans: # vlan: # export_to_pool_flag: # mac_addr: # packet_sample_rate: # packet_sampler: # sticky_mac: # storm_control_policy: # dot1x_enable: # max_miss_heartbeats: # access_mode: # ip_source_guard: # mclag_icl_port: # p2p_port: # aggregator_mode: # rpvst_port: # flow_control: # media_type: # pause_meter: # pause_meter_resume: # trunk_member: # fec_capable: # fec_state: # matched_dpp_intf_tags: # matched_dpp_policy: # port_policy: # status: # dsl_profile: # flap_duration: # flap_rate: # flap_timeout: # flapguard: # interface_tags: # poe_max_power: # poe_standard: # igmp_snooping_flood_reports: # mcast_snooping_flood_traffic: # link_status: # poe_mode_bt_cabable: # poe_port_mode: # poe_port_power: # poe_port_priority: # acl_group: # dhcp_snoop_option82_override: # - circuit_id: # remote_id: # vlan_name: # fortiswitch_acls: # isl_peer_device_sn: # authenticated_port: # encrypted_port: # ptp_status: # restricted_auth_port: # allow_arp_monitor: # export_to: # export_to_pool: # fallback_port: # fgt_peer_device_name: # fgt_peer_port_name: # fiber_port: # flags: # fortilink_port: # isl_local_trunk_name: # isl_peer_device_name: # isl_peer_port_name: # poe_capable: # port_number: # port_prefix_type: # ptp_policy: # speed: # speed_mask: # stacking_port: # switch_id: # virtual_port: # export_tags: # log_mac_event: # pd_capable: # qnq: # override_snmp_community: # override_snmp_sysinfo: # override_snmp_trap_threshold: # override_snmp_user: # poe_detection_type: # remote_log: # - csv: # facility: # name: # port: # server: # severity: # status: # snmp_community: # - events: ["cpu-high", "mem-low", "log-full", "intf-ip", "ent-conf-change", "l2mac"] # hosts: # - id: # ip: # id: # name: # query_v1_port: # query_v1_status: # query_v2c_port: # query_v2c_status: # status: # trap_v1_lport: # trap_v1_rport: # trap_v1_status: # trap_v2c_lport: # trap_v2c_rport: # trap_v2c_status: # snmp_user: # - auth_proto: # auth_pwd: # name: # priv_proto: # priv_pwd: # queries: # query_port: # security_level: # mclag_igmp_snooping_aware: # ip_source_guard: # - binding_entry: # - entry_name: # ip: # mac: # description: # port: # l3_discovered: # qos_drop_policy: # qos_red_probability: # switch_dhcp_opt43_key: # tdr_supported: # custom_command: # - command_entry: # command_name: # firmware_provision: # firmware_provision_version: # dhcp_server_access_list: # firmware_provision_latest: # dhcp_snooping_static_client: # - ip: # mac: # name: # port: # vlan: # ptp_profile: # ptp_status: # route_offload: # route_offload_mclag: # route_offload_router: # - router_ip: # vlan_name: # mgmt_mode: # purdue_level: # radius_nas_ip: # radius_nas_ip_override: # tunnel_discovered: # vlan: # - assignment_priority: # vlan_name: # 802_1X_settings: # link_down_auth: # local_override: # mab_reauth: # mac_called_station_delimiter: # mac_calling_station_delimiter: # mac_case: # mac_password_delimiter: # mac_username_delimiter: # max_reauth_attempt: # reauth_period: # tx_period: # access_profile: # delayed_restart_trigger: # directly_connected: # dynamic_capability: # dynamically_discovered: # flow_identity: # fsw_wan1_admin: # fsw_wan1_peer: # fsw_wan2_admin: # fsw_wan2_peer: # igmp_snooping: # aging_time: # flood_unknown_multicast: # local_override: # vlans: # - proxy: # querier: # querier_addr: # version: # vlan_name: # max_allowed_trunk_members: # mirror: # - dst: # name: # src_egress: # src_ingress: # status: # switching_packet: # owner_vdom: # poe_pre_standard_detection: # pre_provisioned: # sn: # snmp_sysinfo: # contact_info: # description: # engine_id: # location: # status: # snmp_trap_threshold: # trap_high_cpu_threshold: # trap_log_full_threshold: # trap_low_memory_threshold: # staged_image_version: # static_mac: # - description: # id: # interface: # mac: # type: # vlan: # storm_control: # broadcast: # local_override: # rate: # unknown_multicast: # unknown_unicast: # burst_size_level: # stp_instance: # - id: # priority: # stp_settings: # forward_time: # hello_time: # local_override: # max_age: # max_hops: # name: # pending_timer: # revision: # status: # switch_device_tag: # switch_log: # local_override: # severity: # status: # switch_profile: # type: # version: # poe_lldp_detection: # router_static: # - blackhole: # comment: # device: # distance: # dst: # dynamic_gateway: # gateway: # id: # status: # switch_id: # vrf: # router_vrf: # - name: # switch_id: # vrfid: # system_dhcp_server: # - default_gateway: # dns_server1: # dns_server2: # dns_server3: # dns_service: # id: # interface: # ip_range: # - end_ip: # id: # start_ip: # lease_time: # netmask: # ntp_server1: # ntp_server2: # ntp_server3: # ntp_service: # options: # - code: # id: # ip: # type: # value: # status: # switch_id: # system_interface: # - allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "radius-acct"] # interface: # ip: # mode: # name: # status: # switch_id: # type: # vlan: # vrf: # max_poe_budget: 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)