fmgd_system_interface_ipv6 – IPv6 of interface.

Added in version 1.0.0.

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 v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • interface - The parameter in requested url type: str required: true
  • system_interface_ipv6 - IPv6 of interface. type: dict
    • autoconf Enable/disable address auto config. type: str choices: [disable, enable] more...
    • cli_conn6_status (Alias name: cli-conn6-status) Cli conn6 status. type: int more...
    • dhcp6_client_options (Alias name: dhcp6-client-options) Dhcp6 client options. type: list choices: [rapid, iapd, iana, dns, dnsname] more...
    • dhcp6_iapd_list (Alias name: dhcp6-iapd-list) Dhcp6 iapd list. type: list more...
      • iaid Identity association identifier. type: int more...
      • prefix_hint (Alias name: prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str more...
      • prefix_hint_plt (Alias name: prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...
      • prefix_hint_vlt (Alias name: prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int more...
    • dhcp6_information_request (Alias name: dhcp6-information-request) Enable/disable dhcpv6 information request. type: str choices: [disable, enable] more...
    • dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) Enable/disable dhcpv6 prefix delegation. type: str choices: [disable, enable] more...
    • dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str more...
    • dhcp6_relay_ip (Alias name: dhcp6-relay-ip) Dhcpv6 relay ip address. type: list more...
    • dhcp6_relay_service (Alias name: dhcp6-relay-service) Enable/disable dhcpv6 relay. type: str choices: [disable, enable] more...
    • dhcp6_relay_source_interface (Alias name: dhcp6-relay-source-interface) Enable/disable use of address on this interface as the source address of the relay message. type: str choices: [disable, enable] more...
    • dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str more...
    • dhcp6_relay_type (Alias name: dhcp6-relay-type) Dhcpv6 relay type. type: str choices: [regular] more...
    • icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable] more...
    • interface_identifier (Alias name: interface-identifier) Ipv6 interface identifier. type: str more...
    • ip6_address (Alias name: ip6-address) Primary ipv6 address prefix. type: str more...
    • ip6_allowaccess (Alias name: ip6-allowaccess) Allow management access to the interface. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric, scim, probe-response] more...
    • ip6_default_life (Alias name: ip6-default-life) Default life (sec). type: int more...
    • ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
    • ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) Ip6 delegated prefix list. type: list more...
      • autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
      • delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int more...
      • onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable] more...
      • prefix_id (Alias name: prefix-id) Prefix id. type: int more...
      • rdnss Recursive dns server option. type: list more...
      • rdnss_service (Alias name: rdnss-service) Recursive dns service option. type: str choices: [delegated, default, specify] more...
      • subnet Add subnet id to routing prefix. type: str more...
      • upstream_interface (Alias name: upstream-interface) Name of the interface that provides delegated information. type: list more...
      • dnssl_service (Alias name: dnssl-service) Enable/disable use of domain from delegated prefix for dnssl. type: str choices: [disable, enable] more...
    • ip6_dns_server_override (Alias name: ip6-dns-server-override) Enable/disable using the dns server acquired by dhcp. type: str choices: [disable, enable] more...
    • ip6_extra_addr (Alias name: ip6-extra-addr) Ip6 extra addr. type: list more...
      • prefix Ipv6 address prefix. type: str more...
    • ip6_hop_limit (Alias name: ip6-hop-limit) Hop limit (0 means unspecified). type: int more...
    • ip6_link_mtu (Alias name: ip6-link-mtu) Ipv6 link mtu. type: int more...
    • ip6_manage_flag (Alias name: ip6-manage-flag) Enable/disable the managed flag. type: str choices: [disable, enable] more...
    • ip6_max_interval (Alias name: ip6-max-interval) Ipv6 maximum interval (4 to 1800 sec). type: int more...
    • ip6_min_interval (Alias name: ip6-min-interval) Ipv6 minimum interval (3 to 1350 sec). type: int more...
    • ip6_mode (Alias name: ip6-mode) Addressing mode (static, dhcp, delegated). type: str choices: [static, dhcp, pppoe, delegated] more...
    • ip6_other_flag (Alias name: ip6-other-flag) Enable/disable the other ipv6 flag. type: str choices: [disable, enable] more...
    • ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list more...
      • autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable] more...
      • dnssl Dns search list option. type: list more...
      • onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable] more...
      • preferred_life_time (Alias name: preferred-life-time) Preferred life time (sec). type: int more...
      • prefix Ipv6 prefix. type: str more...
      • rdnss Recursive dns server option. type: list more...
      • valid_life_time (Alias name: valid-life-time) Valid life time (sec). type: int more...
    • ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra] more...
    • ip6_reachable_time (Alias name: ip6-reachable-time) Ipv6 reachable time (milliseconds; 0 means unspecified). type: int more...
    • ip6_retrans_time (Alias name: ip6-retrans-time) Ipv6 retransmit time (milliseconds; 0 means unspecified). type: int more...
    • ip6_send_adv (Alias name: ip6-send-adv) Enable/disable sending advertisements about the interface. type: str choices: [disable, enable] more...
    • ip6_subnet (Alias name: ip6-subnet) Subnet to routing prefix. type: str more...
    • ip6_upstream_interface (Alias name: ip6-upstream-interface) Interface name providing delegated information. type: list more...
    • nd_cert (Alias name: nd-cert) Neighbor discovery certificate. type: list more...
    • nd_cga_modifier (Alias name: nd-cga-modifier) Neighbor discovery cga modifier. type: str more...
    • nd_mode (Alias name: nd-mode) Neighbor discovery mode. type: str choices: [basic, SEND-compatible] more...
    • nd_security_level (Alias name: nd-security-level) Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int more...
    • nd_timestamp_delta (Alias name: nd-timestamp-delta) Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int more...
    • nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int more...
    • ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable] more...
    • unique_autoconf_addr (Alias name: unique-autoconf-addr) Enable/disable unique auto config address. type: str choices: [disable, enable] more...
    • vrip6_link_local Link-local ipv6 address of virtual router. type: str more...
    • vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) Enable/disable virtual mac for vrrp. type: str choices: [disable, enable] more...
    • vrrp6 Vrrp6. type: list more...
      • accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable] more...
      • adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int more...
      • ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable] more...
      • preempt Enable/disable preempt mode. type: str choices: [disable, enable] more...
      • priority Priority of the virtual router (1 - 255). type: int more...
      • start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int more...
      • status Enable/disable vrrp. type: str choices: [disable, enable] more...
      • vrdst6 Monitor the route to this destination. type: list more...
      • vrgrp Vrrp group id (1 - 65535). type: int more...
      • vrid Virtual router identifier (1 - 255). type: int more...
      • vrip6 Ipv6 address of the virtual router. type: str more...
      • vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int more...
    • dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int more...
    • dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str more...
    • dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int more...
    • client_options (Alias name: client-options) Client options. type: list more...
      • code Dhcpv6 option code. type: int more...
      • id Id. type: int more...
      • ip6 Dhcp option ip6s. type: str more...
      • type Dhcpv6 option type. type: str choices: [hex, string, ip6, fqdn] more...
      • value Dhcpv6 option value (hexadecimal value must be even). type: str more...
    • ip6_adv_rio (Alias name: ip6-adv-rio) Enable/disable sending advertisements with route information option. type: str choices: [disable, enable] more...
    • ip6_dnssl_list (Alias name: ip6-dnssl-list) Ip6 dnssl list. type: list more...
      • dnssl_life_time (Alias name: dnssl-life-time) Dns search list time in seconds (0 - 4294967295, default = 1800). type: int more...
      • domain Domain name. type: str more...
    • ip6_rdnss_list (Alias name: ip6-rdnss-list) Ip6 rdnss list. type: list more...
      • rdnss Recursive dns server option. type: str more...
      • rdnss_life_time (Alias name: rdnss-life-time) Recursive dns server life time in seconds (0 - 4294967295, default = 1800). type: int more...
    • ip6_route_list (Alias name: ip6-route-list) Ip6 route list. type: list more...
      • route Ipv6 route. type: str more...
      • route_life_time (Alias name: route-life-time) Route life time in seconds (0 - 65535, default = 1800). type: int more...
      • route_pref (Alias name: route-pref) Set route preference to the interface (default = medium). type: str choices: [medium, high, low] more...
    • ip6_route_pref (Alias name: ip6-route-pref) Set route preference to the interface (default = medium). type: str choices: [medium, high, low] more...

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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: IPv6 of interface.
      fortinet.fmgdevice.fmgd_system_interface_ipv6:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        interface: <your own value>
        system_interface_ipv6:
          # autoconf: <value in [disable, enable]>
          # cli_conn6_status: <integer>
          # dhcp6_client_options:
          #   - "rapid"
          #   - "iapd"
          #   - "iana"
          #   - "dns"
          #   - "dnsname"
          # dhcp6_iapd_list:
          #   - iaid: <integer>
          #     prefix_hint: <string>
          #     prefix_hint_plt: <integer>
          #     prefix_hint_vlt: <integer>
          # dhcp6_information_request: <value in [disable, enable]>
          # dhcp6_prefix_delegation: <value in [disable, enable]>
          # dhcp6_relay_interface_id: <string>
          # dhcp6_relay_ip: <list or string>
          # dhcp6_relay_service: <value in [disable, enable]>
          # dhcp6_relay_source_interface: <value in [disable, enable]>
          # dhcp6_relay_source_ip: <string>
          # dhcp6_relay_type: <value in [regular]>
          # icmp6_send_redirect: <value in [disable, enable]>
          # interface_identifier: <string>
          # ip6_address: <string>
          # ip6_allowaccess:
          #   - "https"
          #   - "ping"
          #   - "ssh"
          #   - "snmp"
          #   - "http"
          #   - "telnet"
          #   - "fgfm"
          #   - "capwap"
          #   - "fabric"
          #   - "scim"
          #   - "probe-response"
          # ip6_default_life: <integer>
          # ip6_delegated_prefix_iaid: <integer>
          # ip6_delegated_prefix_list:
          #   - autonomous_flag: <value in [disable, enable]>
          #     delegated_prefix_iaid: <integer>
          #     onlink_flag: <value in [disable, enable]>
          #     prefix_id: <integer>
          #     rdnss: <list or string>
          #     rdnss_service: <value in [delegated, default, specify]>
          #     subnet: <string>
          #     upstream_interface: <list or string>
          #     dnssl_service: <value in [disable, enable]>
          # ip6_dns_server_override: <value in [disable, enable]>
          # ip6_extra_addr:
          #   - prefix: <string>
          # 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_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>
          # ip6_prefix_mode: <value in [dhcp6, ra]>
          # ip6_reachable_time: <integer>
          # ip6_retrans_time: <integer>
          # ip6_send_adv: <value in [disable, enable]>
          # ip6_subnet: <string>
          # ip6_upstream_interface: <list or string>
          # nd_cert: <list or string>
          # nd_cga_modifier: <string>
          # nd_mode: <value in [basic, SEND-compatible]>
          # nd_security_level: <integer>
          # nd_timestamp_delta: <integer>
          # nd_timestamp_fuzz: <integer>
          # ra_send_mtu: <value in [disable, enable]>
          # unique_autoconf_addr: <value in [disable, enable]>
          # vrip6_link_local: <string>
          # vrrp_virtual_mac6: <value in [disable, enable]>
          # vrrp6:
          #   - accept_mode: <value in [disable, enable]>
          #     adv_interval: <integer>
          #     ignore_default_route: <value in [disable, enable]>
          #     preempt: <value in [disable, enable]>
          #     priority: <integer>
          #     start_time: <integer>
          #     status: <value in [disable, enable]>
          #     vrdst6: <list or string>
          #     vrgrp: <integer>
          #     vrid: <integer>
          #     vrip6: <string>
          #     vrdst_priority: <integer>
          # dhcp6_prefix_hint_vlt: <integer>
          # dhcp6_prefix_hint: <string>
          # dhcp6_prefix_hint_plt: <integer>
          # client_options:
          #   - code: <integer>
          #     id: <integer>
          #     ip6: <string>
          #     type: <value in [hex, string, ip6, ...]>
          #     value: <string>
          # ip6_adv_rio: <value in [disable, enable]>
          # ip6_dnssl_list:
          #   - dnssl_life_time: <integer>
          #     domain: <string>
          # ip6_rdnss_list:
          #   - rdnss: <string>
          #     rdnss_life_time: <integer>
          # ip6_route_list:
          #   - route: <string>
          #     route_life_time: <integer>
          #     route_pref: <value in [medium, high, low]>
          # ip6_route_pref: <value in [medium, high, low]>

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:

  • 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)