fmgr_firewall_address6 – Configure IPv6 firewall addresses.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`
firewall_address6	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
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
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
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
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

cache-ttl True True True True True True True True
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

color True True True True True True True True
comment - Comment. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

comment True True True True True True True True
dynamic_mapping - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

dynamic_mapping True True True True True True True True
- _scope - No description for the parameter type: array more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  _scope True True True True True True True True
  - name - No description for the parameter type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    name True True True True True True True True
  - vdom - No description for the parameter type: str more...
    
    6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    vdom True True True True True True True True
- cache-ttl - No description for the parameter type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  cache-ttl True True True True True True True True
- color - No description for the parameter type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  color True True True True True True True True
- comment - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  comment True True True True True True True True
- end-ip - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  end-ip True True True True True True True True
- fqdn - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  fqdn True True True True True True True True
- host - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  host True True True True True True True True
- host-type - No description for the parameter type: str choices: [any, specific] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  host-type True True True True True True True True
- ip6 - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  ip6 True True True True True True True True
- obj-id - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  obj-id True True True True True True True True
- sdn - No description for the parameter type: str choices: [nsx] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  sdn True True True True True True True True
- start-ip - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  start-ip True True True True True True True True
- tags - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  tags True True True True True True True True
- template - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  template True True True True True True True True
- type - No description for the parameter type: str choices: [ipprefix, iprange, dynamic, fqdn, template]
- uuid - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  uuid True True True True True True True True
- visibility - No description for the parameter type: str choices: [disable, enable] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  visibility True True True True True True True True
- subnet-segment - No description for the parameter type: array more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  subnet-segment True True True True True True True
  - name - No description for the parameter type: str more...
    
    6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    name True True True True True True True
  - type - No description for the parameter type: str choices: [any, specific] more...
    
    6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    type True True True True True True True
  - value - No description for the parameter type: str more...
    
    6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
    
    value True True True True True True True
- _image-base64 - No description for the parameter type: str more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  _image-base64 True True True True True True
- end-mac - No description for the parameter type: str more...
  
  6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  end-mac True False True True True
- start-mac - No description for the parameter type: str more...
  
  6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  start-mac True False True True True
- country - No description for the parameter type: str more...
  
  6.4.0 6.4.2 6.4.5 7.0.0
  
  country True True True True
- global-object - No description for the parameter type: int more...
  
  6.4.0 6.4.2 6.4.5 7.0.0
  
  global-object True True True True
- fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
  
  6.4.5 7.0.0
  
  fabric-object True True
- macaddr - No description for the parameter type: str more...
  
  7.0.0
  
  macaddr True
end-ip - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

end-ip True True True True True True True True
fqdn - Fully qualified domain name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

fqdn True True True True True True True True
host - Host Address. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

host True True True True True True True True
host-type - Host type. type: str choices: [any, specific] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

host-type True True True True True True True True
ip6 - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

ip6 True True True True True True True True
list - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

list True True True True True True True True
- ip - IP. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  ip True True True True True True True True
- net-id - Network ID. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  net-id True True True True True True True
- obj-id - Object ID. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  obj-id True True True True True True True
name - Address name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

name True True True True True True True True
obj-id - Object ID for NSX. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

obj-id True True True True True True True True
sdn - SDN. type: str choices: [nsx] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

sdn True True True True True True True True
start-ip - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

start-ip True True True True True True True True
subnet-segment - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

subnet-segment True True True True True True True True
- name - Name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  name True True True True True True True True
- type - Subnet segment type. type: str choices: [any, specific] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  type True True True True True True True True
- value - Subnet segment value. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  value True True True True True True True True
tagging - No description for the parameter type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

tagging True True True True True True True True
- category - Tag category. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  category True True True True True True True True
- name - Tagging entry name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  name True True True True True True True True
- tags - No description for the parameter type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
  
  tags True True True True True True True True
template - IPv6 address template. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

template True True True True True True True True
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...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

uuid True True True True True True True True
visibility - Enable/disable the visibility of the object in the GUI. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

visibility True True True True False False False False
_image-base64 - No description for the parameter type: str more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

_image-base64 True True True True True True
end-mac - Last MAC address in the range. type: str more...

6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

end-mac True False True True False
start-mac - First MAC address in the range. type: str more...

6.2.5 6.4.0 6.4.2 6.4.5 7.0.0

start-mac True False True True False
country - IPv6 addresses associated to a specific country. type: str more...

6.4.0 6.4.2 6.4.5 7.0.0

country True True True True
global-object - Global Object. type: int more...

6.4.0 6.4.2 6.4.5 7.0.0

global-object True True True False
fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...

6.4.5 7.0.0

fabric-object True True
macaddr - No description for the parameter type: str more...

7.0.0

macaddr True

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 ¶

- hosts: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_address6:
           cache-ttl: <value of integer>
           color: <value of integer>
           comment: <value of string>
           dynamic_mapping:
             -
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 end-ip: <value of string>
                 fqdn: <value of string>
                 host: <value of string>
                 host-type: <value in [any, specific]>
                 ip6: <value of string>
                 obj-id: <value of string>
                 sdn: <value in [nsx]>
                 start-ip: <value of string>
                 tags: <value of string>
                 template: <value of string>
                 type: <value in [ipprefix, iprange, dynamic, ...]>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>
                 subnet-segment:
                   -
                       name: <value of string>
                       type: <value in [any, specific]>
                       value: <value of string>
                 _image-base64: <value of string>
                 end-mac: <value of string>
                 start-mac: <value of string>
                 country: <value of string>
                 global-object: <value of integer>
                 fabric-object: <value in [disable, enable]>
                 macaddr: <value of string>
           end-ip: <value of string>
           fqdn: <value of string>
           host: <value of string>
           host-type: <value in [any, specific]>
           ip6: <value of string>
           list:
             -
                 ip: <value of string>
                 net-id: <value of string>
                 obj-id: <value of string>
           name: <value of string>
           obj-id: <value of string>
           sdn: <value in [nsx]>
           start-ip: <value of string>
           subnet-segment:
             -
                 name: <value of string>
                 type: <value in [any, specific]>
                 value: <value of string>
           tagging:
             -
                 category: <value of string>
                 name: <value of string>
                 tags: <value of string>
           template: <value of string>
           type: <value in [ipprefix, iprange, dynamic, ...]>
           uuid: <value of string>
           visibility: <value in [disable, enable]>
           _image-base64: <value of string>
           end-mac: <value of string>
           start-mac: <value of string>
           country: <value of string>
           global-object: <value of integer>
           fabric-object: <value in [disable, enable]>
           macaddr: <value of string>

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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
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.