fortinet.fortimanager.fmgr_fsp_vlan_interface_ipv6 module – IPv6 of interface.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

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

Autoconf.

Choices:

  • "disable"

  • "enable"

cli_conn6_status

aliases: cli-conn6-status

integer

Cli conn6 status.

dhcp6_client_options

aliases: dhcp6-client-options

list / elements=string

Dhcp6 client options.

Choices:

  • "rapid"

  • "iapd"

  • "iana"

  • "dns"

  • "dnsname"

dhcp6_information_request

aliases: dhcp6-information-request

string

Dhcp6 information request.

Choices:

  • "disable"

  • "enable"

dhcp6_prefix_delegation

aliases: dhcp6-prefix-delegation

string

Dhcp6 prefix delegation.

Choices:

  • "disable"

  • "enable"

dhcp6_prefix_hint

aliases: dhcp6-prefix-hint

string

Dhcp6 prefix hint.

dhcp6_prefix_hint_plt

aliases: dhcp6-prefix-hint-plt

integer

Dhcp6 prefix hint plt.

dhcp6_prefix_hint_vlt

aliases: dhcp6-prefix-hint-vlt

integer

Dhcp6 prefix hint vlt.

dhcp6_relay_interface_id

aliases: dhcp6-relay-interface-id

string

DHCP6 relay interface ID.

dhcp6_relay_ip

aliases: dhcp6-relay-ip

string

Dhcp6 relay ip.

dhcp6_relay_service

aliases: dhcp6-relay-service

string

Dhcp6 relay service.

Choices:

  • "disable"

  • "enable"

dhcp6_relay_source_interface

aliases: dhcp6-relay-source-interface

string

Enable/disable use of address on this interface as the source address of the relay message.

Choices:

  • "disable"

  • "enable"

dhcp6_relay_source_ip

aliases: dhcp6-relay-source-ip

string

IPv6 address used by the DHCP6 relay as its source IP.

dhcp6_relay_type

aliases: dhcp6-relay-type

string

Dhcp6 relay type.

Choices:

  • "regular"

icmp6_send_redirect

aliases: icmp6-send-redirect

string

Enable/disable sending of ICMPv6 redirects.

Choices:

  • "disable"

  • "enable"

interface_identifier

aliases: interface-identifier

string

Interface identifier.

ip6_address

aliases: ip6-address

string

Ip6 address.

ip6_allowaccess

aliases: ip6-allowaccess

list / elements=string

Ip6 allowaccess.

Choices:

  • "https"

  • "ping"

  • "ssh"

  • "snmp"

  • "http"

  • "telnet"

  • "fgfm"

  • "capwap"

  • "fabric"

ip6_default_life

aliases: ip6-default-life

integer

Ip6 default life.

ip6_delegated_prefix_iaid

aliases: ip6-delegated-prefix-iaid

integer

IAID of obtained delegated-prefix from the upstream interface.

ip6_delegated_prefix_list

aliases: ip6-delegated-prefix-list

list / elements=dictionary

Ip6 delegated prefix list.

autonomous_flag

aliases: autonomous-flag

string

Autonomous flag.

Choices:

  • "disable"

  • "enable"

delegated_prefix_iaid

aliases: delegated-prefix-iaid

integer

IAID of obtained delegated-prefix from the upstream interface.

onlink_flag

aliases: onlink-flag

string

Onlink flag.

Choices:

  • "disable"

  • "enable"

prefix_id

aliases: prefix-id

integer

Prefix id.

rdnss

any

(list) Rdnss.

rdnss_service

aliases: rdnss-service

string

Rdnss service.

Choices:

  • "delegated"

  • "default"

  • "specify"

subnet

string

Subnet.

upstream_interface

aliases: upstream-interface

string

Upstream interface.

ip6_dns_server_override

aliases: ip6-dns-server-override

string

Ip6 dns server override.

Choices:

  • "disable"

  • "enable"

ip6_extra_addr

aliases: ip6-extra-addr

list / elements=dictionary

Ip6 extra addr.

prefix

string

Prefix.

ip6_hop_limit

aliases: ip6-hop-limit

integer

Ip6 hop limit.

ip6_link_mtu

aliases: ip6-link-mtu

integer

Ip6 link mtu.

ip6_manage_flag

aliases: ip6-manage-flag

string

Ip6 manage flag.

Choices:

  • "disable"

  • "enable"

ip6_max_interval

aliases: ip6-max-interval

integer

Ip6 max interval.

ip6_min_interval

aliases: ip6-min-interval

integer

Ip6 min interval.

ip6_mode

aliases: ip6-mode

string

Ip6 mode.

Choices:

  • "static"

  • "dhcp"

  • "pppoe"

  • "delegated"

ip6_other_flag

aliases: ip6-other-flag

string

Ip6 other flag.

Choices:

  • "disable"

  • "enable"

ip6_prefix_list

aliases: ip6-prefix-list

list / elements=dictionary

Ip6 prefix list.

autonomous_flag

aliases: autonomous-flag

string

Autonomous flag.

Choices:

  • "disable"

  • "enable"

dnssl

any

(list) Dnssl.

onlink_flag

aliases: onlink-flag

string

Onlink flag.

Choices:

  • "disable"

  • "enable"

preferred_life_time

aliases: preferred-life-time

integer

Preferred life time.

prefix

string

Prefix.

rdnss

any

(list) Rdnss.

valid_life_time

aliases: valid-life-time

integer

Valid life time.

ip6_prefix_mode

aliases: ip6-prefix-mode

string

Assigning a prefix from DHCP or RA.

Choices:

  • "dhcp6"

  • "ra"

ip6_reachable_time

aliases: ip6-reachable-time

integer

Ip6 reachable time.

ip6_retrans_time

aliases: ip6-retrans-time

integer

Ip6 retrans time.

ip6_send_adv

aliases: ip6-send-adv

string

Ip6 send adv.

Choices:

  • "disable"

  • "enable"

ip6_subnet

aliases: ip6-subnet

string

Ip6 subnet.

ip6_upstream_interface

aliases: ip6-upstream-interface

string

Ip6 upstream interface.

nd_cert

aliases: nd-cert

string

Nd cert.

nd_cga_modifier

aliases: nd-cga-modifier

string

Nd cga modifier.

nd_mode

aliases: nd-mode

string

Nd mode.

Choices:

  • "basic"

  • "SEND-compatible"

nd_security_level

aliases: nd-security-level

integer

Nd security level.

nd_timestamp_delta

aliases: nd-timestamp-delta

integer

Nd timestamp delta.

nd_timestamp_fuzz

aliases: nd-timestamp-fuzz

integer

Nd timestamp fuzz.

ra_send_mtu

aliases: ra-send-mtu

string

Enable/disable sending link MTU in RA packet.

Choices:

  • "disable"

  • "enable"

unique_autoconf_addr

aliases: unique-autoconf-addr

string

Unique autoconf addr.

Choices:

  • "disable"

  • "enable"

string

Vrip6 link local.

vrrp6

list / elements=dictionary

Vrrp6.

accept_mode

aliases: accept-mode

string

Accept mode.

Choices:

  • "disable"

  • "enable"

adv_interval

aliases: adv-interval

integer

Adv interval.

ignore_default_route

aliases: ignore-default-route

string

Enable/disable ignoring of default route when checking destination.

Choices:

  • "disable"

  • "enable"

preempt

string

Preempt.

Choices:

  • "disable"

  • "enable"

priority

integer

Priority.

start_time

aliases: start-time

integer

Start time.

status

string

Status.

Choices:

  • "disable"

  • "enable"

vrdst6

string

Vrdst6.

vrdst_priority

aliases: vrdst-priority

integer

Priority of the virtual router when the virtual router destination becomes unreachable

vrgrp

integer

Vrgrp.

vrid

integer

Vrid.

vrip6

string

Vrip6.

vrrp_virtual_mac6

aliases: vrrp-virtual-mac6

string

Vrrp virtual mac6.

Choices:

  • "disable"

  • "enable"

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

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)