- source
fmgr_firewall_address6.py
- orphan
1.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name,var name,var.name - New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- 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 (Alias name: cache-ttl) Minimal ttl of individual ipv6 addresses in fqdn cache. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - comment Comment. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - dynamic_mapping Dynamic_mapping. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest- _scope _scope. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - cache_ttl (Alias name: cache-ttl) Minimal ttl of individual ipv6 addresses in fqdn cache. type: int
more...
Supported Version Ranges:
v6.0.0 -> latest - 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...
Supported Version Ranges:
v6.0.0 -> latest - comment Comment. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - end_ip (Alias name: end-ip) Final ip address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - fqdn Fully qualified domain name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - host Host address. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - host_type (Alias name: host-type) Host type. type: str choices: [any, specific]
more...
Supported Version Ranges:
v6.0.0 -> latest - ip6 Ipv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - obj_id (Alias name: obj-id) Object id for nsx. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - sdn Sdn. type: str choices: [nsx]
more...
Supported Version Ranges:
v6.0.0 -> latest - start_ip (Alias name: start-ip) First ip address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - tags Tags. type: list or str
more...
Supported Version Ranges:
v6.0.0 -> latest - template Ipv6 address template. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - type Type of ipv6 address object (default = ipprefix). type: str choices: [ipprefix, iprange, nsx, dynamic, fqdn, template, mac, geography, route-tag]
more...
Supported Version Ranges:
v6.0.0 -> latest - uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - visibility Enable/disable the visibility of the object in the gui. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - subnet_segment (Alias name: subnet-segment) Subnet-segment. type: list
more...
Supported Version Ranges:
v6.2.1 -> latest - _image_base64 (Alias name: _image-base64) _image-base64. type: str
more...
Supported Version Ranges:
v6.2.2 -> latest - end_mac (Alias name: end-mac) Last mac address in the range. type: str
more...
Supported Version Ranges:
v6.2.5 -> v6.2.12,v6.4.1 -> latest - start_mac (Alias name: start-mac) First mac address in the range. type: str
more...
Supported Version Ranges:
v6.2.5 -> v6.2.12,v6.4.1 -> latest - country Country. type: str
more...
Supported Version Ranges:
v6.4.0 -> latest - global_object (Alias name: global-object) Global-object. type: int
more...
Supported Version Ranges:
v6.4.0 -> latest - fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.4 -> latest - macaddr Macaddr. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - epg_name (Alias name: epg-name) Endpoint group name. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - sdn_tag (Alias name: sdn-tag) Sdn tag. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - tenant Tenant. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - route_tag (Alias name: route-tag) Route-tag address. type: int
more...
Supported Version Ranges:
v7.4.0 -> latest
- _scope _scope. type: list
more...
- end_ip (Alias name: end-ip) Final ip address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - fqdn Fully qualified domain name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - host Host address. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - host_type (Alias name: host-type) Host type. type: str choices: [any, specific]
more...
Supported Version Ranges:
v6.0.0 -> latest - ip6 Ipv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - list List. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - name Address name. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - obj_id (Alias name: obj-id) Object id for nsx. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - sdn Sdn. type: str choices: [nsx]
more...
Supported Version Ranges:
v6.0.0 -> latest - start_ip (Alias name: start-ip) First ip address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - subnet_segment (Alias name: subnet-segment) Subnet-segment. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - tagging Tagging. type: list
more...
Supported Version Ranges:
v6.0.0 -> latest - template Ipv6 address template. type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - type Type of ipv6 address object (default = ipprefix). type: str choices: [ipprefix, iprange, nsx, dynamic, fqdn, template, mac, geography, route-tag]
more...
Supported Version Ranges:
v6.0.0 -> latest - uuid Universally unique identifier (uuid; automatically assigned but can be manually reset). type: str
more...
Supported Version Ranges:
v6.0.0 -> latest - visibility Enable/disable the visibility of the object in the gui. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest - tags Names of object-tags applied to address. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.4.14 - profile_list (Alias name: profile-list) type: list
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12- profile_id (Alias name: profile-id) Nsx service profile id. type: int
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_id (Alias name: profile-id) Nsx service profile id. type: int
more...
- _image_base64 (Alias name: _image-base64) _image-base64. type: str
more...
Supported Version Ranges:
v6.2.2 -> latest - end_mac (Alias name: end-mac) Last mac address in the range. type: str
more...
Supported Version Ranges:
v6.2.5 -> v6.2.12,v6.4.1 -> latest - start_mac (Alias name: start-mac) First mac address in the range. type: str
more...
Supported Version Ranges:
v6.2.5 -> v6.2.12,v6.4.1 -> latest - country Ipv6 addresses associated to a specific country. type: str
more...
Supported Version Ranges:
v6.4.0 -> latest - global_object (Alias name: global-object) Global object. type: int
more...
Supported Version Ranges:
v6.4.0 -> latest - fabric_object (Alias name: fabric-object) Security fabric global object setting. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.4 -> latest - macaddr Multiple mac address ranges. type: list
more...
Supported Version Ranges:
v7.0.0 -> latest - epg_name (Alias name: epg-name) Endpoint group name. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - sdn_tag (Alias name: sdn-tag) Sdn tag. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - tenant Tenant. type: str
more...
Supported Version Ranges:
v7.2.1 -> latest - route_tag (Alias name: route-tag) Route-tag address. type: int
more...
Supported Version Ranges:
v7.4.0 -> latest
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
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IPv6 firewall addresses.
fortinet.fortimanager.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
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the IPv6 addresses
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_address6"
params:
adom: "ansible"
address6: "your_value"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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)