:source: fmgd_vpn_ipsec_phase1interface.py :orphan: .. _fmgd_vpn_ipsec_phase1interface: fmgd_vpn_ipsec_phase1interface -- Configure VPN remote gateway. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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 VPN remote gateway. fortinet.fmgdevice.fmgd_vpn_ipsec_phase1interface: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # vpn_ipsec_phase1interface: name: "your value" # Required variable, string # acct_verify: # add_gw_route: # add_route: # aggregate_member: # aggregate_weight: # assign_ip: # assign_ip_from: # authmethod: # authmethod_remote: # authpasswd: # authusr: # authusrgrp: # auto_discovery_crossover: # auto_discovery_forwarder: # auto_discovery_offer_interval: # auto_discovery_psk: # auto_discovery_receiver: # auto_discovery_sender: # auto_discovery_shortcuts: # auto_negotiate: # azure_ad_autoconnect: # backup_gateway: # banner: # cert_id_validation: # cert_peer_username_strip: # cert_peer_username_validation: # cert_trust_store: # certificate: # childless_ike: # client_auto_negotiate: # client_keep_alive: # client_resume: # client_resume_interval: # comments: # default_gw: # default_gw_priority: # dev_id: # dev_id_notification: # dhcp_ra_giaddr: # dhcp6_ra_linkaddr: # dhgrp: # - "1" # - "2" # - "5" # - "14" # - "15" # - "16" # - "17" # - "18" # - "19" # - "20" # - "21" # - "27" # - "28" # - "29" # - "30" # - "31" # - "32" # digital_signature_auth: # distance: # dns_mode: # domain: # dpd: # dpd_retrycount: # dpd_retryinterval: # eap: # eap_cert_auth: # eap_exclude_peergrp: # eap_identity: # ems_sn_check: # encap_local_gw4: # encap_local_gw6: # encap_remote_gw4: # encap_remote_gw6: # encapsulation: # encapsulation_address: # enforce_unique_id: # esn: # exchange_fgt_device_id: # exchange_interface_ip: # exchange_ip_addr4: # exchange_ip_addr6: # fallback_tcp_threshold: # fec_base: # fec_codec: # fec_egress: # fec_health_check: # fec_ingress: # fec_mapping_profile: # fec_receive_timeout: # fec_redundant: # fec_send_timeout: # fgsp_sync: # fortinet_esp: # fragmentation: # fragmentation_mtu: # group_authentication: # group_authentication_secret: # ha_sync_esp_seqno: # idle_timeout: # idle_timeoutinterval: # ike_version: # inbound_dscp_copy: # include_local_lan: # interface: # internal_domain_list: # ip_delay_interval: # ip_fragmentation: # ip_version: # ipsec_tunnel_slot: # ipv4_dns_server1: # ipv4_dns_server2: # ipv4_dns_server3: # ipv4_end_ip: # ipv4_exclude_range: # - end_ip: # id: # start_ip: # ipv4_name: # ipv4_netmask: # ipv4_split_exclude: # ipv4_split_include: # ipv4_start_ip: # ipv4_wins_server1: # ipv4_wins_server2: # ipv6_dns_server1: # ipv6_dns_server2: # ipv6_dns_server3: # ipv6_end_ip: # ipv6_exclude_range: # - end_ip: # id: # start_ip: # ipv6_name: # ipv6_prefix: # ipv6_split_exclude: # ipv6_split_include: # ipv6_start_ip: # keepalive: # keylife: # kms: # link_cost: # local_gw: # local_gw6: # localid: # localid_type: # loopback_asymroute: # mesh_selector_type: # mode: # mode_cfg: # mode_cfg_allow_client_selector: # monitor: # monitor_hold_down_delay: # monitor_hold_down_time: # monitor_hold_down_type: # monitor_hold_down_weekday: # monitor_min: # nattraversal: # negotiate_timeout: # net_device: # network_id: # network_overlay: # npu_offload: # packet_redistribution: # passive_mode: # peer: # peergrp: # peerid: # peertype: # ppk: # ppk_identity: # ppk_secret: # priority: # proposal: # psksecret: # psksecret_remote: # qkd: # qkd_profile: # reauth: # rekey: # remote_gw: # remote_gw_country: # remote_gw_end_ip: # remote_gw_match: # remote_gw_start_ip: # remote_gw_subnet: # remote_gw6: # remote_gw6_country: # remote_gw6_end_ip: # remote_gw6_match: # remote_gw6_start_ip: # remote_gw6_subnet: # remotegw_ddns: # rsa_signature_format: # rsa_signature_hash_override: # save_password: # send_cert_chain: # signature_hash_alg: # - "sha1" # - "sha2-256" # - "sha2-384" # - "sha2-512" # split_include_service: # suite_b: # transit_gateway: # transport: # type: # unity_support: # usrgrp: # vni: # wizard_type: # xauthtype: # forticlient_enforcement: # tunnel_search: # addke1: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke2: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke3: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke4: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke5: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke6: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # addke7: # - "0" # - "1080" # - "1081" # - "1082" # - "1083" # - "1084" # - "1085" # - "1089" # - "1090" # - "1091" # - "1092" # - "1093" # - "1094" # - "35" # - "36" # - "37" # auto_transport_threshold: # ipv6_auto_linklocal: # remote_gw_ztna_tags: # shared_idle_timeout: # auto_discovery_dialup_placeholder: # qkd_hybrid: # mobike: # peer_egress_shaping: # dns_suffix_search: # peer_egress_shaping_value: 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)