fmgr_firewall_address6 – Configure IPv6 firewall addresses.

New in version 1.0.0.

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.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

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_address6 - Configure IPv6 firewall addresses. type: dict
    • cache-ttl - Minimal TTL of individual IPv6 addresses in FQDN cache. type: int more...
    • color - Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1). type: int more...
    • comment - Comment. type: str more...
    • dynamic_mapping - Dynamic_Mapping. type: array more...
      • _scope - _Scope. type: array more...
        • name - Name. type: str more...
        • vdom - Vdom. type: str more...
      • cache-ttl - Minimal TTL of individual IPv6 addresses in FQDN cache. type: int more...
      • color - Integer value to determine the color of the icon in the GUI (range 1 to 32, default = 0, which sets the value to 1). type: int more...
      • comment - Comment. type: str more...
      • end-ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
      • fqdn - Fully qualified domain name. type: str more...
      • host - Host Address. type: str more...
      • host-type - Host type. type: str choices: [any, specific] more...
      • ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...
      • obj-id - Object ID for NSX. type: str more...
      • sdn - SDN. type: str choices: [nsx] more...
      • start-ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
      • tags - Tags. type: str more...
      • template - IPv6 address template. type: str more...
      • type - Type of IPv6 address object (default = ipprefix). type: str choices: [ipprefix, iprange, dynamic, fqdn, template]
      • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      • visibility - Enable/disable the visibility of the object in the GUI. type: str choices: [disable, enable] more...
      • subnet-segment - Subnet-Segment. type: array more...
        • name - Name. type: str more...
        • type - Subnet segment type. type: str choices: [any, specific] more...
        • value - Subnet segment value. type: str more...
      • _image-base64 - _Image-Base64. type: str more...
      • end-mac - Last MAC address in the range. type: str more...
      • start-mac - First MAC address in the range. type: str more...
      • country - Country. type: str more...
      • global-object - Global-Object. type: int more...
      • fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
      • macaddr - Macaddr. type: str more...
      • epg-name - Endpoint group name. type: str more...
      • sdn-tag - SDN Tag. type: str more...
      • tenant - Tenant. type: str more...
      • route-tag - route-tag address. type: int more...
    • end-ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
    • fqdn - Fully qualified domain name. type: str more...
    • host - Host Address. type: str more...
    • host-type - Host type. type: str choices: [any, specific] more...
    • ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...
    • list - List. type: array more...
      • ip - IP. type: str more...
      • net-id - Network ID. type: str more...
      • obj-id - Object ID. type: str more...
    • name - Address name. type: str more...
    • obj-id - Object ID for NSX. type: str more...
    • sdn - SDN. type: str choices: [nsx] more...
    • start-ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...
    • subnet-segment - Subnet-Segment. type: array more...
      • name - Name. type: str more...
      • type - Subnet segment type. type: str choices: [any, specific] more...
      • value - Subnet segment value. type: str more...
    • tagging - Tagging. type: array more...
      • category - Tag category. type: str more...
      • name - Tagging entry name. type: str more...
      • tags - Tags. type: str more...
    • template - IPv6 address template. type: str more...
    • type - Type of IPv6 address object (default = ipprefix). type: str choices: [ipprefix, iprange, dynamic, fqdn, template]
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
    • visibility - Enable/disable the visibility of the object in the GUI. type: str choices: [disable, enable] more...
    • tags - Names of object-tags applied to address. type: str more...
    • profile-list - No description for the parameter type: array more...
      • profile-id - NSX service profile ID. type: int more...
    • _image-base64 - _Image-Base64. type: str more...
    • end-mac - Last MAC address in the range. type: str more...
    • start-mac - First MAC address in the range. type: str more...
    • country - IPv6 addresses associated to a specific country. type: str more...
    • global-object - Global Object. type: int more...
    • fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
    • macaddr - Multiple MAC address ranges. type: str more...
    • epg-name - Endpoint group name. type: str more...
    • sdn-tag - SDN Tag. type: str more...
    • tenant - Tenant. type: str more...
    • route-tag - route-tag address. type: int 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: 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 IPv6 addresses
     fmgr_fact:
       facts:
           selector: 'firewall_address6'
           params:
               adom: 'ansible'
               address6: 'your_value'
- 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 IPv6 firewall addresses.
     fmgr_firewall_address6:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_address6:
           host-type: any #<value in [any, specific]>
           ip6: '::/55'
           name: 'ansible-test'
           visibility: disable

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 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.