fmgr_firewall_vip46 – Configure IPv4 to IPv6 virtual IPs.

Added in version 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.

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 v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • firewall_vip46 - Configure IPv4 to IPv6 virtual IPs. type: dict
    • arp_reply (Alias name: arp-reply) Enable arp reply. type: str choices: [disable, enable] more...
    • color Color of icon on the gui. type: int more...
    • comment Comment. type: str more...
    • dynamic_mapping Dynamic_mapping. type: list more...
      • _scope _scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • arp_reply (Alias name: arp-reply) Enable arp reply. type: str choices: [disable, enable] more...
      • color Color of icon on the gui. type: int more...
      • comment Comment. type: str more...
      • extip Start-external-ip [-end-external-ip]. type: str more...
      • extport External service port. type: str more...
      • id Custom defined id. type: int more...
      • ldb_method (Alias name: ldb-method) Load balance method. type: str choices: [static, round-robin, weighted, least-session, least-rtt, first-alive] more...
      • mappedip Start-mapped-ip [-end mapped-ip]. type: str more...
      • mappedport Mapped service port. type: str more...
      • monitor Health monitors. type: list or str more...
      • portforward Enable port forwarding. type: str choices: [disable, enable] more...
      • protocol Mapped port protocol. type: str choices: [tcp, udp] more...
      • server_type (Alias name: server-type) Server type. type: str choices: [http, tcp, udp, ip] more...
      • src_filter (Alias name: src-filter) Source ip filter (x. type: list more...
      • type Vip type: static nat or server load balance. type: str choices: [static-nat, server-load-balance] more...
      • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
      • srcintf_filter (Alias name: srcintf-filter) Interfaces to which the vip46 applies. type: list or str more...
    • extip Start-external-ip [-end-external-ip]. type: str more...
    • extport External service port. type: str more...
    • id Custom defined id. type: int more...
    • ldb_method (Alias name: ldb-method) Load balance method. type: str choices: [static, round-robin, weighted, least-session, least-rtt, first-alive] more...
    • mappedip Start-mapped-ip [-end mapped-ip]. type: str more...
    • mappedport Mapped service port. type: str more...
    • monitor Health monitors. type: list or str more...
    • name Vip46 name. type: str more...
    • portforward Enable port forwarding. type: str choices: [disable, enable] more...
    • protocol Mapped port protocol. type: str choices: [tcp, udp] more...
    • realservers Realservers. type: list more...
      • client_ip (Alias name: client-ip) Restrict server to a client ip in this range. type: str more...
      • healthcheck Per server health check. type: str choices: [disable, enable, vip] more...
      • holddown_interval (Alias name: holddown-interval) Hold down interval. type: int more...
      • id Real server id. type: int more...
      • ip Mapped server ipv6. type: str more...
      • max_connections (Alias name: max-connections) Maximum number of connections allowed to server. type: int more...
      • monitor Health monitors. type: list or str more...
      • port Mapped server port. type: int more...
      • status Server administrative status. type: str choices: [active, standby, disable] more...
      • weight Weight. type: int more...
    • server_type (Alias name: server-type) Server type. type: str choices: [http, tcp, udp, ip] more...
    • src_filter (Alias name: src-filter) Source ip filter (x. type: list more...
    • type Vip type: static nat. type: str choices: [static-nat, server-load-balance] more...
    • uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str more...
    • srcintf_filter (Alias name: srcintf-filter) Interfaces to which the vip46 applies. type: list or str more...

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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 to IPv6 virtual IPs.
      fortinet.fortimanager.fmgr_firewall_vip46:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vip46:
          arp-reply: enable
          color: 1
          comment: "ansible-comment"
          id: 1
          ldb-method: static # <value in [static, round-robin, weighted, ...]>
          name: "ansible-test-vip46"
          protocol: tcp # <value in [tcp, udp]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv4 to IPv6 virtual IPs
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip46"
          params:
            adom: "ansible"
            vip46: "your_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:

  • 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)