Try SpotterConfigure IPv6 firewall addresses.
| "added in version" 1.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
firewall_address6:
description: the top level parameters set
required: false
suboptions:
_image-base64:
description: _Image-Base64.
type: str
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
type: int
comment:
description: Comment.
type: str
country:
description: IPv6 addresses associated to a specific country.
type: str
dynamic_mapping:
description: Dynamic_Mapping.
elements: dict
suboptions:
_image-base64:
description: _Image-Base64.
type: str
_scope:
description: _Scope.
elements: dict
suboptions:
name:
description: Name.
type: str
vdom:
description: Vdom.
type: str
type: list
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
type: int
comment:
description: Comment.
type: str
country:
description: Country.
type: str
end-ip:
description: Final IP address
type: str
end-mac:
description: Last MAC address in the range.
type: str
epg-name:
description: Endpoint group name.
type: str
fabric-object:
choices:
- disable
- enable
description: Security Fabric global object setting.
type: str
fqdn:
description: Fully qualified domain name.
type: str
global-object:
description: Global-Object.
type: int
host:
description: Host Address.
type: str
host-type:
choices:
- any
- specific
description: Host type.
type: str
ip6:
description: IPv6 address prefix
type: str
macaddr:
description: Macaddr.
type: str
obj-id:
description: Object ID for NSX.
type: str
route-tag:
description: route-tag address.
type: int
sdn:
choices:
- nsx
description: SDN.
type: str
sdn-tag:
description: SDN Tag.
type: str
start-ip:
description: First IP address
type: str
start-mac:
description: First MAC address in the range.
type: str
subnet-segment:
description: Subnet-Segment.
elements: dict
suboptions:
name:
description: Name.
type: str
type:
choices:
- any
- specific
description: Subnet segment type.
type: str
value:
description: Subnet segment value.
type: str
type: list
tags:
description: Tags.
type: str
template:
description: IPv6 address template.
type: str
tenant:
description: Tenant.
type: str
type:
choices:
- ipprefix
- iprange
- dynamic
- fqdn
- template
description: Type of IPv6 address object
type: str
uuid:
description: Universally Unique Identifier
type: str
visibility:
choices:
- disable
- enable
description: Enable/disable the visibility of the object in the GUI.
type: str
type: list
end-ip:
description: Final IP address
type: str
end-mac:
description: Last MAC address in the range.
type: str
epg-name:
description: Endpoint group name.
type: str
fabric-object:
choices:
- disable
- enable
description: Security Fabric global object setting.
type: str
fqdn:
description: Fully qualified domain name.
type: str
global-object:
description: Global Object.
type: int
host:
description: Host Address.
type: str
host-type:
choices:
- any
- specific
description: Host type.
type: str
ip6:
description: IPv6 address prefix
type: str
list:
description: List.
elements: dict
suboptions:
ip:
description: IP.
type: str
net-id:
description: Network ID.
type: str
obj-id:
description: Object ID.
type: str
type: list
macaddr:
description: Multiple MAC address ranges.
type: str
name:
description: Address name.
type: str
obj-id:
description: Object ID for NSX.
type: str
profile-list:
description: description
elements: dict
suboptions:
profile-id:
description: NSX service profile ID.
type: int
type: list
route-tag:
description: route-tag address.
type: int
sdn:
choices:
- nsx
description: SDN.
type: str
sdn-tag:
description: SDN Tag.
type: str
start-ip:
description: First IP address
type: str
start-mac:
description: First MAC address in the range.
type: str
subnet-segment:
description: Subnet-Segment.
elements: dict
suboptions:
name:
description: Name.
type: str
type:
choices:
- any
- specific
description: Subnet segment type.
type: str
value:
description: Subnet segment value.
type: str
type: list
tagging:
description: Tagging.
elements: dict
suboptions:
category:
description: Tag category.
type: str
name:
description: Tagging entry name.
type: str
tags:
description: Tags.
type: str
type: list
tags:
description: Names of object-tags applied to address.
type: str
template:
description: IPv6 address template.
type: str
tenant:
description: Tenant.
type: str
type:
choices:
- ipprefix
- iprange
- dynamic
- fqdn
- template
description: Type of IPv6 address object
type: str
uuid:
description: Universally Unique Identifier
type: str
visibility:
choices:
- disable
- enable
description: Enable/disable the visibility of the object in the GUI.
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
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_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list