fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6 module – IPv6 of interface.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The top level parameters set. |
|
Autoconf. Choices:
|
|
Deprecated, please rename it to cli_conn6_status. Cli conn6 status. |
|
Deprecated, please rename it to dhcp6_client_options. Dhcp6 client options. Choices:
|
|
Deprecated, please rename it to dhcp6_information_request. Dhcp6 information request. Choices:
|
|
Deprecated, please rename it to dhcp6_prefix_delegation. Dhcp6 prefix delegation. Choices:
|
|
Deprecated, please rename it to dhcp6_prefix_hint. Dhcp6 prefix hint. |
|
Deprecated, please rename it to dhcp6_prefix_hint_plt. Dhcp6 prefix hint plt. |
|
Deprecated, please rename it to dhcp6_prefix_hint_vlt. Dhcp6 prefix hint vlt. |
|
Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID. |
|
Deprecated, please rename it to dhcp6_relay_ip. Dhcp6 relay ip. |
|
Deprecated, please rename it to dhcp6_relay_service. Dhcp6 relay service. Choices:
|
|
Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interface as the sourc… Choices:
|
|
Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its source IP. |
|
Deprecated, please rename it to dhcp6_relay_type. Dhcp6 relay type. Choices:
|
|
Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects. Choices:
|
|
Deprecated, please rename it to interface_identifier. Interface identifier. |
|
Deprecated, please rename it to ip6_address. Ip6 address. |
|
Deprecated, please rename it to ip6_allowaccess. Ip6 allowaccess. Choices:
|
|
Deprecated, please rename it to ip6_default_life. Ip6 default life. |
|
Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream interface. |
|
Deprecated, please rename it to ip6_delegated_prefix_list. Ip6 delegated prefix list. |
|
Deprecated, please rename it to autonomous_flag. Autonomous flag. Choices:
|
|
Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream interface. |
|
Deprecated, please rename it to onlink_flag. Onlink flag. Choices:
|
|
Deprecated, please rename it to prefix_id. Prefix id. |
|
(list) Rdnss. |
|
Deprecated, please rename it to rdnss_service. Rdnss service. Choices:
|
|
Subnet. |
|
Deprecated, please rename it to upstream_interface. Upstream interface. |
|
Deprecated, please rename it to ip6_dns_server_override. Ip6 dns server override. Choices:
|
|
Deprecated, please rename it to ip6_extra_addr. Ip6 extra addr. |
|
Prefix. |
|
Deprecated, please rename it to ip6_hop_limit. Ip6 hop limit. |
|
Deprecated, please rename it to ip6_link_mtu. Ip6 link mtu. |
|
Deprecated, please rename it to ip6_manage_flag. Ip6 manage flag. Choices:
|
|
Deprecated, please rename it to ip6_max_interval. Ip6 max interval. |
|
Deprecated, please rename it to ip6_min_interval. Ip6 min interval. |
|
Deprecated, please rename it to ip6_mode. Ip6 mode. Choices:
|
|
Deprecated, please rename it to ip6_other_flag. Ip6 other flag. Choices:
|
|
Deprecated, please rename it to ip6_prefix_list. Ip6 prefix list. |
|
Deprecated, please rename it to autonomous_flag. Autonomous flag. Choices:
|
|
(list) Dnssl. |
|
Deprecated, please rename it to onlink_flag. Onlink flag. Choices:
|
|
Deprecated, please rename it to preferred_life_time. Preferred life time. |
|
Prefix. |
|
(list) Rdnss. |
|
Deprecated, please rename it to valid_life_time. Valid life time. |
|
Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA. Choices:
|
|
Deprecated, please rename it to ip6_reachable_time. Ip6 reachable time. |
|
Deprecated, please rename it to ip6_retrans_time. Ip6 retrans time. |
|
Deprecated, please rename it to ip6_send_adv. Ip6 send adv. Choices:
|
|
Deprecated, please rename it to ip6_subnet. Ip6 subnet. |
|
Deprecated, please rename it to ip6_upstream_interface. Ip6 upstream interface. |
|
Deprecated, please rename it to nd_cert. Nd cert. |
|
Deprecated, please rename it to nd_cga_modifier. Nd cga modifier. |
|
Deprecated, please rename it to nd_mode. Nd mode. Choices:
|
|
Deprecated, please rename it to nd_security_level. Nd security level. |
|
Deprecated, please rename it to nd_timestamp_delta. Nd timestamp delta. |
|
Deprecated, please rename it to nd_timestamp_fuzz. Nd timestamp fuzz. |
|
Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet. Choices:
|
|
Deprecated, please rename it to unique_autoconf_addr. Unique autoconf addr. Choices:
|
|
Vrip6 link local. |
|
Deprecated, please rename it to vrrp_virtual_mac6. Vrrp virtual mac6. Choices:
|
|
Vrrp6. |
|
Deprecated, please rename it to accept_mode. Accept mode. Choices:
|
|
Deprecated, please rename it to adv_interval. Adv interval. |
|
Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route when checking desti… Choices:
|
|
Preempt. Choices:
|
|
Priority. |
|
Deprecated, please rename it to start_time. Start time. |
|
Status. Choices:
|
|
Deprecated, please rename it to vrdst_priority. Priority of the virtual router when the virtual router destination… |
|
Vrdst6. |
|
Vrgrp. |
|
Vrid. |
|
Vrip6. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The parameter (vlan) in requested url. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: IPv6 of interface.
fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6:
# 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>
vlan: <your own value>
fsp_vlan_interface_ipv6:
autoconf: <value in [disable, enable]>
dhcp6_client_options:
- rapid
- iapd
- iana
- dns
- dnsname
dhcp6_information_request: <value in [disable, enable]>
dhcp6_prefix_delegation: <value in [disable, enable]>
dhcp6_prefix_hint: <string>
dhcp6_prefix_hint_plt: <integer>
dhcp6_prefix_hint_vlt: <integer>
dhcp6_relay_ip: <string>
dhcp6_relay_service: <value in [disable, enable]>
dhcp6_relay_type: <value in [regular]>
ip6_address: <string>
ip6_allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
ip6_default_life: <integer>
ip6_dns_server_override: <value in [disable, enable]>
ip6_hop_limit: <integer>
ip6_link_mtu: <integer>
ip6_manage_flag: <value in [disable, enable]>
ip6_max_interval: <integer>
ip6_min_interval: <integer>
ip6_mode: <value in [static, dhcp, pppoe, ...]>
ip6_other_flag: <value in [disable, enable]>
ip6_reachable_time: <integer>
ip6_retrans_time: <integer>
ip6_send_adv: <value in [disable, enable]>
ip6_subnet: <string>
ip6_upstream_interface: <string>
nd_cert: <string>
nd_cga_modifier: <string>
nd_mode: <value in [basic, SEND-compatible]>
nd_security_level: <integer>
nd_timestamp_delta: <integer>
nd_timestamp_fuzz: <integer>
vrip6_link_local: <string>
vrrp_virtual_mac6: <value in [disable, enable]>
ip6_delegated_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
onlink_flag: <value in [disable, enable]>
prefix_id: <integer>
rdnss: <list or string>
rdnss_service: <value in [delegated, default, specify]>
subnet: <string>
upstream_interface: <string>
delegated_prefix_iaid: <integer>
ip6_extra_addr:
-
prefix: <string>
ip6_prefix_list:
-
autonomous_flag: <value in [disable, enable]>
dnssl: <list or string>
onlink_flag: <value in [disable, enable]>
preferred_life_time: <integer>
prefix: <string>
rdnss: <list or string>
valid_life_time: <integer>
vrrp6:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
preempt: <value in [disable, enable]>
priority: <integer>
start_time: <integer>
status: <value in [disable, enable]>
vrdst6: <string>
vrgrp: <integer>
vrid: <integer>
vrip6: <string>
ignore_default_route: <value in [disable, enable]>
vrdst_priority: <integer>
interface_identifier: <string>
unique_autoconf_addr: <value in [disable, enable]>
icmp6_send_redirect: <value in [disable, enable]>
cli_conn6_status: <integer>
ip6_prefix_mode: <value in [dhcp6, ra]>
ra_send_mtu: <value in [disable, enable]>
ip6_delegated_prefix_iaid: <integer>
dhcp6_relay_source_interface: <value in [disable, enable]>
dhcp6_relay_interface_id: <string>
dhcp6_relay_source_ip: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |