:source: fmgr_fsp_vlan_dynamicmapping.py :orphan: .. _fmgr_fsp_vlan_dynamicmapping: fmgr_fsp_vlan_dynamicmapping -- Fsp vlan dynamic mapping. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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: Fsp vlan dynamic mapping fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping: # workspace_locking_adom: adom: vlan: state: present # fsp_vlan_dynamicmapping: # _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: 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)