/ home / chillancezen / chillancezen.fortimanager / 2.1.6 / module / fmgr_firewall_vip

chillancezen.fortimanager.fmgr_firewall_vip (2.1.6) — module

no description

| "added in version" 1.0.0 of chillancezen.fortimanager"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install chillancezen.fortimanager:==2.1.6

Add to requirements.yml

  collections:
    - name: chillancezen.fortimanager
      version: 2.1.6

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

 - name: gathering fortimanager facts
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
   tasks:
    - name: retrieve all the virtual IPs for IPv4
      fmgr_fact:
        facts:
            selector: 'firewall_vip'
            params:
                adom: 'ansible'
                vip: 'your_value'

Scanned by Steampunk Spotter

 - hosts: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure virtual IP for IPv4.
      fmgr_firewall_vip:
         bypass_validation: True
         adom: ansible
         state: present
         firewall_vip:
            arp-reply: disable #<value in [disable, enable]>
            color: 1
            comment: 'ansible-comment'
            id: 1
            name: 'ansible-test-vip'
            protocol: tcp #<value in [tcp, udp, sctp, ...]>
            type: load-balance #<value in [static-nat, load-balance, server-load-balance, ...]>

Scanned by Steampunk Spotter

 - name: Demo of cloning objects in FortiManager
   hosts: fortimanager00
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
     initial_vip_object: 'vip_object0'
     cloned_vip_objects:
         - name: 'vip_object1'
           comment: 'vip_object1 is cloned!'
         - name: 'vip_object2'
           comment: 'vip_object2 is cloned!'
   tasks:
     - name: Create An VIP object
       fmgr_firewall_vip:
         adom: 'root'
         state: 'present'
         firewall_vip:
             arp-reply: 'disable'
             comment: 'The VIP is created via Ansible'
             name: '{{ initial_vip_object }}'
             protocol: 'tcp'
             type: 'load-balance'
     - name: Clone an VIP object using fmgr_clone module.
       fmgr_clone:
         rc_succeeded: [-2]
         clone:
          selector: 'firewall_vip'
          self:
            adom: 'root'
            vip: '{{ initial_vip_object }}'
          target:
            name: '{{ item.name }}'
            comment: '{{ item.comment }}'
       with_items: '{{ cloned_vip_objects }}'

Outputs

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_message:
  description: The descriptive message of the api response
  returned: always
  sample: OK.
  type: str