:source: fmgd_switchcontroller_managedswitch_ports.py :orphan: .. _fmgd_switchcontroller_managedswitch_ports: fmgd_switchcontroller_managedswitch_ports -- Managed-switch port list. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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: Managed-switch port list. fortinet.fmgdevice.fmgd_switchcontroller_managedswitch_ports: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: managed_switch: state: present # switchcontroller_managedswitch_ports: # access_mode: # acl_group: # aggregator_mode: # allow_arp_monitor: # allowed_vlans: # allowed_vlans_all: # arp_inspection_trust: # authenticated_port: # bundle: # description: # dhcp_snoop_option82_override: # - circuit_id: # remote_id: # vlan_name: # dhcp_snoop_option82_trust: # dhcp_snooping: # discard_mode: # dsl_profile: # edge_port: # encrypted_port: # export_to: # export_to_pool: # export_to_pool_flag: # fallback_port: # fec_capable: # fec_state: # fgt_peer_device_name: # fgt_peer_port_name: # fiber_port: # flags: # flap_duration: # flap_rate: # flap_timeout: # flapguard: # flow_control: # fortilink_port: # fortiswitch_acls: # igmp_snooping_flood_reports: # interface_tags: # ip_source_guard: # isl_local_trunk_name: # isl_peer_device_name: # isl_peer_device_sn: # isl_peer_port_name: # lacp_speed: # learning_limit: # link_status: # lldp_profile: # lldp_status: # loop_guard: # loop_guard_timeout: # mac_addr: # matched_dpp_intf_tags: # matched_dpp_policy: # max_bundle: # mcast_snooping_flood_traffic: # mclag: # mclag_icl_port: # media_type: # member_withdrawal_behavior: # members: # min_bundle: # mode: # p2p_port: # packet_sample_rate: # packet_sampler: # pause_meter: # pause_meter_resume: # poe_capable: # poe_max_power: # poe_mode_bt_cabable: # poe_port_mode: # poe_port_power: # poe_port_priority: # poe_pre_standard_detection: # poe_standard: # poe_status: # port_name: # port_number: # port_owner: # port_policy: # port_prefix_type: # port_security_policy: # port_selection_criteria: # ptp_policy: # ptp_status: # qos_policy: # restricted_auth_port: # rpvst_port: # sample_direction: # sflow_counter_interval: # speed: # speed_mask: # stacking_port: # status: # sticky_mac: # storm_control_policy: # stp_bpdu_guard: # stp_bpdu_guard_timeout: # stp_root_guard: # stp_state: # switch_id: # trunk_member: # type: # untagged_vlans: # virtual_port: # vlan: # igmps_flood_reports: # igmps_flood_traffic: # export_tags: # igmp_snooping: # log_mac_event: # pd_capable: # qnq: 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)