:source: fmgd_firewall_vip.py :orphan: .. _fmgd_firewall_vip: fmgd_firewall_vip -- Configure virtual IP for IPv4. +++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.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.4.8 -> v7.4.10, v7.6.4 -> 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 virtual IP for IPv4. fortinet.fmgdevice.fmgd_firewall_vip: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # firewall_vip: id: 0 # Required variable, integer # arp_reply: # color: # comment: # dynamic_mapping: # - _scope: # - name: # vdom: # add_nat46_route: # arp_reply: # color: # comment: # dns_mapping_ttl: # extaddr: # extintf: # extip: # extport: # gratuitous_arp_interval: # gslb_domain_name: # gslb_hostname: # h2_support: # h3_support: # http_cookie_age: # http_cookie_domain: # http_cookie_domain_from_host: # http_cookie_generation: # http_cookie_path: # http_cookie_share: # http_ip_header: # http_ip_header_name: # http_multiplex: # http_multiplex_max_concurrent_request: # http_multiplex_max_request: # http_multiplex_ttl: # http_redirect: # http_supported_max_version: # https_cookie_secure: # id: # ipv6_mappedip: # ipv6_mappedport: # ldb_method: # mapped_addr: # mappedip: # mappedport: # max_embryonic_connections: # monitor: # nat_source_vip: # nat44: # nat46: # one_click_gslb_server: # outlook_web_access: # persistence: # portforward: # portmapping_type: # protocol: # realservers: # - address: # client_ip: # health_check_proto: # healthcheck: # holddown_interval: # http_host: # id: # ip: # max_connections: # monitor: # port: # seq: # status: # translate_host: # type: # verify_cert: # weight: # server_type: # service: # src_filter: # src_vip_filter: # srcintf_filter: # ssl_accept_ffdhe_groups: # ssl_algorithm: # ssl_certificate: # ssl_cipher_suites: # - cipher: # id: # priority: # versions: # - "ssl-3.0" # - "tls-1.0" # - "tls-1.1" # - "tls-1.2" # - "tls-1.3" # ssl_client_fallback: # ssl_client_rekey_count: # ssl_client_renegotiation: # ssl_client_session_state_max: # ssl_client_session_state_timeout: # ssl_client_session_state_type: # ssl_dh_bits: # ssl_hpkp: # ssl_hpkp_age: # ssl_hpkp_backup: # ssl_hpkp_include_subdomains: # ssl_hpkp_primary: # ssl_hpkp_report_uri: # ssl_hsts: # ssl_hsts_age: # ssl_hsts_include_subdomains: # ssl_http_location_conversion: # ssl_http_match_host: # ssl_max_version: # ssl_min_version: # ssl_mode: # ssl_pfs: # ssl_send_empty_frags: # ssl_server_algorithm: # ssl_server_max_version: # ssl_server_min_version: # ssl_server_renegotiation: # ssl_server_session_state_max: # ssl_server_session_state_timeout: # ssl_server_session_state_type: # status: # type: # uuid: # weblogic_server: # websphere_server: # client_cert: # empty_cert_action: # user_agent_detect: # vip_id: # extintf: # extip: # extport: # gratuitous_arp_interval: # h2_support: # h3_support: # http_cookie_age: # http_cookie_domain: # http_cookie_domain_from_host: # http_cookie_generation: # http_cookie_path: # http_cookie_share: # http_ip_header: # http_ip_header_name: # http_multiplex: # http_multiplex_max_concurrent_request: # http_multiplex_max_request: # http_multiplex_ttl: # http_redirect: # http_supported_max_version: # https_cookie_secure: # ldb_method: # mappedip: # mappedport: # max_embryonic_connections: # name: # outlook_web_access: # persistence: # portforward: # portmapping_type: # protocol: # quic: # ack_delay_exponent: # active_connection_id_limit: # active_migration: # grease_quic_bit: # max_ack_delay: # max_datagram_frame_size: # max_idle_timeout: # max_udp_payload_size: # realservers: # - address: # client_ip: # health_check_proto: # healthcheck: # holddown_interval: # http_host: # ip: # max_connections: # port: # seq: # status: # translate_host: # type: # verify_cert: # weight: # monitor: # id: # server_type: # ssl_accept_ffdhe_groups: # ssl_algorithm: # ssl_certificate: # ssl_cipher_suites: # - cipher: # id: # versions: # - "ssl-3.0" # - "tls-1.0" # - "tls-1.1" # - "tls-1.2" # - "tls-1.3" # priority: # ssl_client_fallback: # ssl_client_rekey_count: # ssl_client_renegotiation: # ssl_client_session_state_max: # ssl_client_session_state_timeout: # ssl_client_session_state_type: # ssl_dh_bits: # ssl_hpkp: # ssl_hpkp_age: # ssl_hpkp_backup: # ssl_hpkp_include_subdomains: # ssl_hpkp_primary: # ssl_hpkp_report_uri: # ssl_hsts: # ssl_hsts_age: # ssl_hsts_include_subdomains: # ssl_http_location_conversion: # ssl_http_match_host: # ssl_max_version: # ssl_min_version: # ssl_mode: # ssl_pfs: # ssl_send_empty_frags: # ssl_server_algorithm: # ssl_server_cipher_suites: # - cipher: # priority: # versions: # - "ssl-3.0" # - "tls-1.0" # - "tls-1.1" # - "tls-1.2" # - "tls-1.3" # ssl_server_max_version: # ssl_server_min_version: # ssl_server_renegotiation: # ssl_server_session_state_max: # ssl_server_session_state_timeout: # ssl_server_session_state_type: # status: # type: # uuid: # weblogic_server: # websphere_server: # src_filter: # mapped_addr: # nat_source_vip: # dns_mapping_ttl: # service: # nat46: # add_nat46_route: # gslb_public_ips: # - index: # ip: # monitor: # nat44: # src_vip_filter: # extaddr: # srcintf_filter: # ipv6_mappedip: # gslb_domain_name: # one_click_gslb_server: # ipv6_mappedport: # gslb_hostname: # client_cert: # empty_cert_action: # user_agent_detect: # vip_id: 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)