fortinet.fortimanager.fmgr_firewall_vip64 (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 IPv6 to IPv4 virtual IPs.
      fortinet.fortimanager.fmgr_firewall_vip64:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vip64:
          arp-reply: enable
          color: 1
          comment: "anisble-comment"
          id: 1
          name: "ansible-test-vip64"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 IPv6 to IPv4 virtual IPs
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip64"
          params:
            adom: "ansible"
            vip64: "your_value"

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

firewall_vip64:
    description: The top level parameters set.
    required: false
    suboptions:
      arp-reply:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to arp_reply. Enable ARP reply.
        type: str
      color:
        description: Color of icon on the GUI.
        type: int
      comment:
        description: Comment.
        type: str
      dynamic_mapping:
        description: Dynamic_Mapping.
        elements: dict
        suboptions:
          _scope:
            description: _Scope.
            elements: dict
            suboptions:
              name:
                description: Name.
                type: str
              vdom:
                description: Vdom.
                type: str
            type: list
          arp-reply:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to arp_reply. Enable ARP reply.
            type: str
          color:
            description: Color of icon on the GUI.
            type: int
          comment:
            description: Comment.
            type: str
          extip:
            description: Start-external-IP [-end-external-IP].
            type: str
          extport:
            description: External service port.
            type: str
          id:
            description: Custom defined id.
            type: int
          ldb-method:
            choices:
            - static
            - round-robin
            - weighted
            - least-session
            - least-rtt
            - first-alive
            description: Deprecated, please rename it to ldb_method. Load balance method.
            type: str
          mappedip:
            description: Start-mapped-IP [-end-mapped-IP].
            type: str
          mappedport:
            description: Mapped service port.
            type: str
          monitor:
            description: (list or str) Health monitors.
            type: raw
          portforward:
            choices:
            - disable
            - enable
            description: Enable port forwarding.
            type: str
          protocol:
            choices:
            - tcp
            - udp
            description: Mapped port protocol.
            type: str
          server-type:
            choices:
            - http
            - tcp
            - udp
            - ip
            description: Deprecated, please rename it to server_type. Server type.
            type: str
          src-filter:
            description: (list) Deprecated, please rename it to src_filter. Source IP6
              filter
            type: raw
          type:
            choices:
            - static-nat
            - server-load-balance
            description: VIP type
            type: str
          uuid:
            description: Universally Unique Identifier
            type: str
        type: list
      extip:
        description: Start-external-IP [-end-external-IP].
        type: str
      extport:
        description: External service port.
        type: str
      id:
        description: Custom defined id.
        type: int
      ldb-method:
        choices:
        - static
        - round-robin
        - weighted
        - least-session
        - least-rtt
        - first-alive
        description: Deprecated, please rename it to ldb_method. Load balance method.
        type: str
      mappedip:
        description: Start-mapped-IP [-end-mapped-IP].
        type: str
      mappedport:
        description: Mapped service port.
        type: str
      monitor:
        description: (list or str) Health monitors.
        type: raw
      name:
        description: VIP64 name.
        required: true
        type: str
      portforward:
        choices:
        - disable
        - enable
        description: Enable port forwarding.
        type: str
      protocol:
        choices:
        - tcp
        - udp
        description: Mapped port protocol.
        type: str
      realservers:
        description: Realservers.
        elements: dict
        suboptions:
          client-ip:
            description: Deprecated, please rename it to client_ip. Restrict server to
              a client IP in this range.
            type: str
          healthcheck:
            choices:
            - disable
            - enable
            - vip
            description: Per server health check.
            type: str
          holddown-interval:
            description: Deprecated, please rename it to holddown_interval. Hold down
              interval.
            type: int
          id:
            description: Real server ID.
            type: int
          ip:
            description: Mapped server IP.
            type: str
          max-connections:
            description: Deprecated, please rename it to max_connections. Maximum number
              of connections allowed to server.
            type: int
          monitor:
            description: (list or str) Health monitors.
            type: raw
          port:
            description: Mapped server port.
            type: int
          status:
            choices:
            - active
            - standby
            - disable
            description: Server administrative status.
            type: str
          weight:
            description: Weight.
            type: int
        type: list
      server-type:
        choices:
        - http
        - tcp
        - udp
        - ip
        description: Deprecated, please rename it to server_type. Server type.
        type: str
      src-filter:
        description: (list) Deprecated, please rename it to src_filter. Source IP6 filter
        type: raw
      type:
        choices:
        - static-nat
        - server-load-balance
        description: VIP type
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
    type: dict

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list