fmgr_firewall_address_dynamicmapping – Configure IPv4 addresses.¶
New in version 2.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
- address - The parameter in requested url type: str required: true
- firewall_address_dynamicmapping - Configure IPv4 addresses. type: dict
- _scope - No description for the parameter type: array more...
- allow-routing - No description for the parameter type: str choices: [disable, enable] more...
- associated-interface - No description for the parameter type: str more...
- cache-ttl - No description for the parameter type: int more...
- color - No description for the parameter type: int more...
- comment - No description for the parameter type: dict more...
- country - No description for the parameter type: str more...
- end-ip - No description for the parameter type: str more...
- end-mac - No description for the parameter type: str more...
- epg-name - No description for the parameter type: str more...
- filter - No description for the parameter type: str more...
- fqdn - No description for the parameter type: str more...
- interface - No description for the parameter type: str more...
- obj-id - No description for the parameter type: str more...
- organization - No description for the parameter type: str more...
- policy-group - No description for the parameter type: str more...
- sdn - No description for the parameter type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack] more...
- sdn-addr-type - No description for the parameter type: str choices: [private, public, all] more...
- sdn-tag - No description for the parameter type: str more...
- start-ip - No description for the parameter type: str more...
- start-mac - No description for the parameter type: str more...
- subnet - No description for the parameter type: str more...
- subnet-name - No description for the parameter type: str more...
- tags - No description for the parameter type: str more...
- tenant - No description for the parameter type: str more...
- type - No description for the parameter type: str choices: [ipmask, iprange, fqdn, wildcard, geography, url, wildcard-fqdn, nsx, aws, dynamic, interface-subnet, mac, fqdn-group, route-tag] more...
- url - No description for the parameter type: str more...
- uuid - No description for the parameter type: str more...
- visibility - No description for the parameter type: str choices: [disable, enable] more...
- wildcard - No description for the parameter type: str more...
- wildcard-fqdn - No description for the parameter type: str more...
- _image-base64 - No description for the parameter type: str more...
- clearpass-spt - No description for the parameter type: str choices: [unknown, healthy, quarantine, checkup, transition, infected, transient] more...
- fsso-group - No description for the parameter type: str more...
- sub-type - No description for the parameter type: str choices: [sdn, clearpass-spt, fsso, ems-tag, swc-tag, fortivoice-tag, fortinac-tag, fortipolicy-tag, device-identification] more...
- global-object - No description for the parameter type: int more...
- obj-tag - No description for the parameter type: str more...
- obj-type - No description for the parameter type: str choices: [ip, mac] more...
- fabric-object - Security Fabric global object setting. type: str choices: [disable, enable] more...
- macaddr - No description for the parameter type: str more...
- node-ip-only - Enable/disable collection of node addresses only in Kubernetes. type: str choices: [disable, enable] more...
- dirty - To be deleted address. type: str choices: [dirty, clean] more...
- pattern-end - No description for the parameter type: int more...
- pattern-start - No description for the parameter type: int more...
- tag-detection-level - Tag detection level of dynamic address object. type: str more...
- tag-type - Tag type of dynamic address object. type: str more...
- hw-model - Dynamic address matching hardware model. type: str more...
- hw-vendor - Dynamic address matching hardware vendor. type: str more...
- os - Dynamic address matching operating system. type: str more...
- route-tag - route-tag address. type: int more...
- sw-version - Dynamic address matching software version. type: str 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¶
- 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 dynamic mappings of IPv4 address
fmgr_firewall_address_dynamicmapping:
bypass_validation: True
adom: ansible
address: 'ansible-test1' # name
state: present
firewall_address_dynamicmapping:
_scope:
-
name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
allow-routing: disable #<value in [disable, enable]>
cache-ttl: 0
color: 1
comment: 'ansible-comment'
subnet: '222.222.222.101/32'
subnet-name: 'ansible-test'
type: ipmask #<value in [ipmask, iprange, fqdn, ...]>
visibility: enable
- 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 dynamic mappings of IPv4 address
fmgr_fact:
facts:
selector: 'firewall_address_dynamicmapping'
params:
adom: 'ansible'
address: 'ansible-test1' # name
dynamic_mapping: 'your_value'
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