fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6 module – IPv6 of interface.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

fsp_vlan_interface_ipv6

dictionary

The top level parameters set.

autoconf

string

No description.

Choices:

  • "disable"

  • "enable"

cli-conn6-status

integer

Deprecated, please rename it to cli_conn6_status.

dhcp6-client-options

list / elements=string

Deprecated, please rename it to dhcp6_client_options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6-information-request

string

Deprecated, please rename it to dhcp6_information_request.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-delegation

string

Deprecated, please rename it to dhcp6_prefix_delegation.

Choices:

  • "disable"

  • "enable"

dhcp6-prefix-hint

string

Deprecated, please rename it to dhcp6_prefix_hint.

dhcp6-prefix-hint-plt

integer

Deprecated, please rename it to dhcp6_prefix_hint_plt.

dhcp6-prefix-hint-vlt

integer

Deprecated, please rename it to dhcp6_prefix_hint_vlt.

dhcp6-relay-interface-id

string

Deprecated, please rename it to dhcp6_relay_interface_id. DHCP6 relay interface ID.

dhcp6-relay-ip

string

Deprecated, please rename it to dhcp6_relay_ip.

dhcp6-relay-service

string

Deprecated, please rename it to dhcp6_relay_service.

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-interface

string

Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable use of address on this interface as the sourc…

Choices:

  • "disable"

  • "enable"

dhcp6-relay-source-ip

string

Deprecated, please rename it to dhcp6_relay_source_ip. IPv6 address used by the DHCP6 relay as its source IP.

dhcp6-relay-type

string

Deprecated, please rename it to dhcp6_relay_type.

Choices:

  • "regular"

icmp6-send-redirect

string

Deprecated, please rename it to icmp6_send_redirect. Enable/disable sending of ICMPv6 redirects.

Choices:

  • "disable"

  • "enable"

interface-identifier

string

Deprecated, please rename it to interface_identifier.

ip6-address

string

Deprecated, please rename it to ip6_address.

ip6-allowaccess

list / elements=string

Deprecated, please rename it to ip6_allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6-default-life

integer

Deprecated, please rename it to ip6_default_life.

ip6-delegated-prefix-iaid

integer

Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream interface.

ip6-delegated-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_delegated_prefix_list.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag.

Choices:

  • "disable"

  • "enable"

delegated-prefix-iaid

integer

Deprecated, please rename it to delegated_prefix_iaid. IAID of obtained delegated-prefix from the upstream interface.

string

Deprecated, please rename it to onlink_flag.

Choices:

  • "disable"

  • "enable"

prefix-id

integer

Deprecated, please rename it to prefix_id.

rdnss

any

(list) No description.

rdnss-service

string

Deprecated, please rename it to rdnss_service.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

No description.

upstream-interface

string

Deprecated, please rename it to upstream_interface.

ip6-dns-server-override

string

Deprecated, please rename it to ip6_dns_server_override.

Choices:

  • "disable"

  • "enable"

ip6-extra-addr

list / elements=dictionary

Deprecated, please rename it to ip6_extra_addr.

prefix

string

No description.

ip6-hop-limit

integer

Deprecated, please rename it to ip6_hop_limit.

integer

Deprecated, please rename it to ip6_link_mtu.

ip6-manage-flag

string

Deprecated, please rename it to ip6_manage_flag.

Choices:

  • "disable"

  • "enable"

ip6-max-interval

integer

Deprecated, please rename it to ip6_max_interval.

ip6-min-interval

integer

Deprecated, please rename it to ip6_min_interval.

ip6-mode

string

Deprecated, please rename it to ip6_mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6-other-flag

string

Deprecated, please rename it to ip6_other_flag.

Choices:

  • "disable"

  • "enable"

ip6-prefix-list

list / elements=dictionary

Deprecated, please rename it to ip6_prefix_list.

autonomous-flag

string

Deprecated, please rename it to autonomous_flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) No description.

string

Deprecated, please rename it to onlink_flag.

Choices:

  • "disable"

  • "enable"

preferred-life-time

integer

Deprecated, please rename it to preferred_life_time.

prefix

string

No description.

rdnss

any

(list) No description.

valid-life-time

integer

Deprecated, please rename it to valid_life_time.

ip6-prefix-mode

string

Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix from DHCP or RA.

Choices:

  • "dhcp6"

  • "ra"

ip6-reachable-time

integer

Deprecated, please rename it to ip6_reachable_time.

ip6-retrans-time

integer

Deprecated, please rename it to ip6_retrans_time.

ip6-send-adv

string

Deprecated, please rename it to ip6_send_adv.

Choices:

  • "disable"

  • "enable"

ip6-subnet

string

Deprecated, please rename it to ip6_subnet.

ip6-upstream-interface

string

Deprecated, please rename it to ip6_upstream_interface.

nd-cert

string

Deprecated, please rename it to nd_cert.

nd-cga-modifier

string

Deprecated, please rename it to nd_cga_modifier.

nd-mode

string

Deprecated, please rename it to nd_mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd-security-level

integer

Deprecated, please rename it to nd_security_level.

nd-timestamp-delta

integer

Deprecated, please rename it to nd_timestamp_delta.

nd-timestamp-fuzz

integer

Deprecated, please rename it to nd_timestamp_fuzz.

ra-send-mtu

string

Deprecated, please rename it to ra_send_mtu. Enable/disable sending link MTU in RA packet.

Choices:

  • "disable"

  • "enable"

unique-autoconf-addr

string

Deprecated, please rename it to unique_autoconf_addr.

Choices:

  • "disable"

  • "enable"

string

No description.

vrrp-virtual-mac6

string

Deprecated, please rename it to vrrp_virtual_mac6.

Choices:

  • "disable"

  • "enable"

vrrp6

list / elements=dictionary

No description.

accept-mode

string

Deprecated, please rename it to accept_mode.

Choices:

  • "disable"

  • "enable"

adv-interval

integer

Deprecated, please rename it to adv_interval.

ignore-default-route

string

Deprecated, please rename it to ignore_default_route. Enable/disable ignoring of default route when checking desti…

Choices:

  • "disable"

  • "enable"

preempt

string

No description.

Choices:

  • "disable"

  • "enable"

priority

integer

No description.

start-time

integer

Deprecated, please rename it to start_time.

status

string

No description.

Choices:

  • "disable"

  • "enable"

vrdst6

string

No description.

vrgrp

integer

No description.

vrid

integer

No description.

vrip6

string

No description.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

vlan

string / required

The parameter (vlan) in requested url.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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]>
          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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)