ansible.builtin.fortios_firewall_address6 (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall feature and address6 category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPv6 firewall addresses.
    fortios_firewall_address6:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      firewall_address6:
        state: "present"
        cache-ttl: "3"
        color: "4"
        comment: "Comment."
        end-ip: "<your_own_value>"
        fqdn: "<your_own_value>"
        host: "<your_own_value>"
        host-type: "any"
        ip6: "<your_own_value>"
        list:
         -
            ip: "<your_own_value>"
        name: "default_name_13"
        obj-id: "<your_own_value>"
        sdn: "nsx"
        start-ip: "<your_own_value>"
        subnet-segment:
         -
            name: "default_name_18"
            type: "any"
            value: "<your_own_value>"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_23"
            tags:
             -
                name: "default_name_25 (source system.object-tagging.tags.name)"
        template: "<your_own_value> (source firewall.address6-template.name)"
        type: "ipprefix"
        uuid: "<your_own_value>"
        visibility: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: false
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_address6:
    default: null
    description:
    - Configure IPv6 firewall addresses.
    suboptions:
      cache-ttl:
        description:
        - Minimal TTL of individual IPv6 addresses in FQDN cache.
      color:
        description:
        - Integer value to determine the color of the icon in the GUI (range 1 to 32,
          default = 0, which sets the value to 1).
      comment:
        description:
        - Comment.
      end-ip:
        description:
        - 'Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).'
      fqdn:
        description:
        - Fully qualified domain name.
      host:
        description:
        - Host Address.
      host-type:
        choices:
        - any
        - specific
        description:
        - Host type.
      ip6:
        description:
        - 'IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).'
      list:
        description:
        - IP address list.
        suboptions:
          ip:
            description:
            - IP.
            required: true
      name:
        description:
        - Address name.
        required: true
      obj-id:
        description:
        - Object ID for NSX.
      sdn:
        choices:
        - nsx
        description:
        - SDN.
      start-ip:
        description:
        - 'First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).'
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object
      subnet-segment:
        description:
        - IPv6 subnet segments.
        suboptions:
          name:
            description:
            - Name.
            required: true
          type:
            choices:
            - any
            - specific
            description:
            - Subnet segment type.
          value:
            description:
            - Subnet segment value.
      tagging:
        description:
        - Config object tagging
        suboptions:
          category:
            description:
            - Tag category. Source system.object-tagging.category.
          name:
            description:
            - Tagging entry name.
            required: true
          tags:
            description:
            - Tags.
            suboptions:
              name:
                description:
                - Tag name. Source system.object-tagging.tags.name.
                required: true
      template:
        description:
        - IPv6 address template. Source firewall.address6-template.name.
      type:
        choices:
        - ipprefix
        - iprange
        - fqdn
        - dynamic
        - template
        description:
        - Type of IPv6 address object (default = ipprefix).
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
      visibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable the visibility of the object in the GUI.

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: key1
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str