fmgr_firewall_address – Configure IPv4 addresses.¶
New in version 2.10.
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
Parameters¶
- 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_address - Configure IPv4 addresses. type: dict
- allow-routing - Enable/disable use of this address in the static route configuration. type: str choices: [disable, enable]
- associated-interface - Network interface associated with address. type: str
- cache-ttl - Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds. type: int
- color - Color of icon on the GUI. type: int
- comment - No description for the parameter type: dict
- country - IP addresses associated to a specific country. type: str
- dynamic_mapping - No description for the parameter type: array
- _scope - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- allow-routing - No description for the parameter type: str choices: [disable, enable]
- associated-interface - No description for the parameter type: str
- cache-ttl - No description for the parameter type: int
- color - No description for the parameter type: int
- comment - No description for the parameter type: dict
- country - No description for the parameter type: str
- end-ip - No description for the parameter type: str
- end-mac - No description for the parameter type: str
- epg-name - No description for the parameter type: str
- filter - No description for the parameter type: str
- fqdn - No description for the parameter type: str
- interface - No description for the parameter type: str
- obj-id - No description for the parameter type: str
- organization - No description for the parameter type: str
- policy-group - No description for the parameter type: str
- sdn - No description for the parameter type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack]
- sdn-addr-type - No description for the parameter type: str choices: [private, public, all]
- sdn-tag - No description for the parameter type: str
- start-ip - No description for the parameter type: str
- start-mac - No description for the parameter type: str
- subnet - No description for the parameter type: str
- subnet-name - No description for the parameter type: str
- tags - No description for the parameter type: str
- tenant - No description for the parameter type: str
- type - No description for the parameter type: str choices: [ipmask, iprange, fqdn, wildcard, geography, url, wildcard-fqdn, nsx, aws, dynamic, interface-subnet, mac]
- url - No description for the parameter type: str
- uuid - No description for the parameter type: str
- visibility - No description for the parameter type: str choices: [disable, enable]
- wildcard - No description for the parameter type: str
- wildcard-fqdn - No description for the parameter type: str
- _scope - No description for the parameter type: array
- end-ip - Final IP address (inclusive) in the range for the address. type: str
- epg-name - Endpoint group name. type: str
- filter - Match criteria filter. type: str
- fqdn - Fully Qualified Domain Name address. type: str
- list - No description for the parameter type: array
- ip - IP. type: str
- name - Address name. type: str
- obj-id - Object ID for NSX. type: str
- organization - Organization domain name (Syntax: organization/domain). type: str
- policy-group - Policy group name. type: str
- sdn - SDN. type: str choices: [aci, aws, nsx, nuage, azure, gcp, oci, openstack]
- sdn-tag - SDN Tag. type: str
- start-ip - First IP address (inclusive) in the range for the address. type: str
- subnet - IP address and subnet mask of address. type: str
- subnet-name - Subnet name. type: str
- tagging - No description for the parameter type: array
- category - Tag category. type: str
- name - Tagging entry name. type: str
- tags - No description for the parameter type: str
- tenant - Tenant. type: str
- type - Type of address. type: str choices: [ipmask, iprange, fqdn, wildcard, geography, url, wildcard-fqdn, nsx, aws, dynamic, interface-subnet, mac]
- uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str
- visibility - Enable/disable address visibility in the GUI. type: str choices: [disable, enable]
- wildcard - IP address and wildcard netmask. type: str
- wildcard-fqdn - Fully Qualified Domain Name with wildcard characters. type: str
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 IPv4 addresses.
fmgr_firewall_address:
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_address:
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of dict>
country: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of dict>
country: <value of string>
end-ip: <value of string>
end-mac: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
interface: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-addr-type: <value in [private, public, all]>
sdn-tag: <value of string>
start-ip: <value of string>
start-mac: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
url: <value of string>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
end-ip: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
list:
-
ip: <value of string>
name: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-tag: <value of string>
start-ip: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <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