fortinet.fortios.fortios_firewall_address6 (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure IPv6 firewall addresses.
  fortinet.fortios.fortios_firewall_address6:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address6:
          cache_ttl: "0"
          color: "0"
          comment: "Comment."
          country: "<your_own_value>"
          end_ip: "<your_own_value>"
          end_mac: "<your_own_value>"
          epg_name: "<your_own_value>"
          fabric_object: "enable"
          fqdn: "<your_own_value>"
          host: "myhostname"
          host_type: "any"
          ip6: "<your_own_value>"
          list:
              -
                  ip: "<your_own_value>"
                  net_id: "<your_own_value>"
                  obj_id: "<your_own_value>"
          macaddr:
              -
                  macaddr: "<your_own_value>"
          name: "default_name_21"
          obj_id: "<your_own_value>"
          route_tag: "0"
          sdn: "nsx"
          sdn_tag: "<your_own_value>"
          start_ip: "<your_own_value>"
          start_mac: "<your_own_value>"
          subnet_segment:
              -
                  name: "default_name_29"
                  type: "any"
                  value: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_34"
                  tags:
                      -
                          name: "default_name_36 (source system.object-tagging.tags.name)"
          template: "<your_own_value> (source firewall.address6-template.name)"
          tenant: "<your_own_value>"
          type: "ipprefix"
          uuid: "<your_own_value>"
          visibility: "enable"

Inputs

    
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.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

firewall_address6:
    default: null
    description:
    - Configure IPv6 firewall addresses.
    suboptions:
      cache_ttl:
        description:
        - Minimal TTL of individual IPv6 addresses in FQDN cache.
        type: int
      color:
        description:
        - Integer value to determine the color of the icon in the GUI (range 1 to 32).
        type: int
      comment:
        description:
        - Comment.
        type: str
      country:
        description:
        - IPv6 addresses associated to a specific country.
        type: str
      end_ip:
        description:
        - 'Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).'
        type: str
      end_mac:
        description:
        - Last MAC address in the range.
        type: str
      epg_name:
        description:
        - Endpoint group name.
        type: str
      fabric_object:
        choices:
        - enable
        - disable
        description:
        - Security Fabric global object setting.
        type: str
      fqdn:
        description:
        - Fully qualified domain name.
        type: str
      host:
        description:
        - Host Address.
        type: str
      host_type:
        choices:
        - any
        - specific
        description:
        - Host type.
        type: str
      ip6:
        description:
        - 'IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx).'
        type: str
      list:
        description:
        - IP address list.
        elements: dict
        suboptions:
          ip:
            description:
            - IP.
            required: true
            type: str
          net_id:
            description:
            - Network ID.
            type: str
          obj_id:
            description:
            - Object ID.
            type: str
        type: list
      macaddr:
        description:
        - Multiple MAC address ranges.
        elements: dict
        suboptions:
          macaddr:
            description:
            - MAC address ranges <start>[-<end>] separated by space.
            required: true
            type: str
        type: list
      name:
        description:
        - Address name.
        required: true
        type: str
      obj_id:
        description:
        - Object ID for NSX.
        type: str
      route_tag:
        description:
        - route-tag address.
        type: int
      sdn:
        choices:
        - nsx
        description:
        - SDN. Source system.sdn-connector.name.
        type: str
      sdn_tag:
        description:
        - SDN Tag.
        type: str
      start_ip:
        description:
        - 'First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx).'
        type: str
      start_mac:
        description:
        - First MAC address in the range.
        type: str
      subnet_segment:
        description:
        - IPv6 subnet segments.
        elements: dict
        suboptions:
          name:
            description:
            - Name.
            required: true
            type: str
          type:
            choices:
            - any
            - specific
            description:
            - Subnet segment type.
            type: str
          value:
            description:
            - Subnet segment value.
            type: str
        type: list
      tagging:
        description:
        - Config object tagging.
        elements: dict
        suboptions:
          category:
            description:
            - Tag category. Source system.object-tagging.category.
            type: str
          name:
            description:
            - Tagging entry name.
            required: true
            type: str
          tags:
            description:
            - Tags.
            elements: dict
            suboptions:
              name:
                description:
                - Tag name. Source system.object-tagging.tags.name.
                required: true
                type: str
            type: list
        type: list
      template:
        description:
        - IPv6 address template. Source firewall.address6-template.name.
        type: str
      tenant:
        description:
        - Tenant.
        type: str
      type:
        choices:
        - ipprefix
        - iprange
        - fqdn
        - geography
        - dynamic
        - template
        - mac
        - route-tag
        description:
        - Type of IPv6 address object .
        type: str
      uuid:
        description:
        - Universally Unique Identifier (UUID; automatically assigned but can be manually
          reset).
        type: str
      visibility:
        choices:
        - enable
        - disable
        description:
        - Enable/disable the visibility of the object in the GUI.
        type: str
    type: dict

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: id
  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