fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_ipv6 (2.4.0) — module

IPv6 of interface.

| "added in version" 2.1.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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_dynamicmapping_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>
        dynamic_mapping: <your own value>
        fsp_vlan_dynamicmapping_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_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_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_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]>
          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>
          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]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

vlan:
    description: The parameter (vlan) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

dynamic_mapping:
    description: The parameter (dynamic_mapping) in requested url.
    required: true
    type: str

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

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

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

fsp_vlan_dynamicmapping_interface_ipv6:
    description: The top level parameters set.
    required: false
    suboptions:
      autoconf:
        choices:
        - disable
        - enable
        description: No description.
        type: str
      cli-conn6-status:
        description: Deprecated, please rename it to cli_conn6_status.
        type: int
      dhcp6-client-options:
        choices:
        - rapid
        - iapd
        - iana
        - dns
        - dnsname
        description: Deprecated, please rename it to dhcp6_client_options.
        elements: str
        type: list
      dhcp6-information-request:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dhcp6_information_request.
        type: str
      dhcp6-prefix-delegation:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dhcp6_prefix_delegation.
        type: str
      dhcp6-prefix-hint:
        description: Deprecated, please rename it to dhcp6_prefix_hint.
        type: str
      dhcp6-prefix-hint-plt:
        description: Deprecated, please rename it to dhcp6_prefix_hint_plt.
        type: int
      dhcp6-prefix-hint-vlt:
        description: Deprecated, please rename it to dhcp6_prefix_hint_vlt.
        type: int
      dhcp6-relay-ip:
        description: Deprecated, please rename it to dhcp6_relay_ip.
        type: str
      dhcp6-relay-service:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dhcp6_relay_service.
        type: str
      dhcp6-relay-source-interface:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dhcp6_relay_source_interface. Enable/disable
          use of address on this interface as the sourc...
        type: str
      dhcp6-relay-type:
        choices:
        - regular
        description: Deprecated, please rename it to dhcp6_relay_type.
        type: str
      icmp6-send-redirect:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to icmp6_send_redirect. Enable/disable
          sending of ICMPv6 redirects.
        type: str
      interface-identifier:
        description: Deprecated, please rename it to interface_identifier.
        type: str
      ip6-address:
        description: Deprecated, please rename it to ip6_address.
        type: str
      ip6-allowaccess:
        choices:
        - https
        - ping
        - ssh
        - snmp
        - http
        - telnet
        - fgfm
        - capwap
        - fabric
        description: Deprecated, please rename it to ip6_allowaccess.
        elements: str
        type: list
      ip6-default-life:
        description: Deprecated, please rename it to ip6_default_life.
        type: int
      ip6-delegated-prefix-iaid:
        description: Deprecated, please rename it to ip6_delegated_prefix_iaid. IAID of
          obtained delegated-prefix from the upstream interface.
        type: int
      ip6-delegated-prefix-list:
        description: Deprecated, please rename it to ip6_delegated_prefix_list.
        elements: dict
        suboptions:
          autonomous-flag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to autonomous_flag.
            type: str
          delegated-prefix-iaid:
            description: Deprecated, please rename it to delegated_prefix_iaid. IAID of
              obtained delegated-prefix from the upstream interface.
            type: int
          onlink-flag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to onlink_flag.
            type: str
          prefix-id:
            description: Deprecated, please rename it to prefix_id.
            type: int
          rdnss:
            description: (list) No description.
            type: raw
          rdnss-service:
            choices:
            - delegated
            - default
            - specify
            description: Deprecated, please rename it to rdnss_service.
            type: str
          subnet:
            description: No description.
            type: str
          upstream-interface:
            description: Deprecated, please rename it to upstream_interface.
            type: str
        type: list
      ip6-dns-server-override:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip6_dns_server_override.
        type: str
      ip6-extra-addr:
        description: Deprecated, please rename it to ip6_extra_addr.
        elements: dict
        suboptions:
          prefix:
            description: No description.
            type: str
        type: list
      ip6-hop-limit:
        description: Deprecated, please rename it to ip6_hop_limit.
        type: int
      ip6-link-mtu:
        description: Deprecated, please rename it to ip6_link_mtu.
        type: int
      ip6-manage-flag:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip6_manage_flag.
        type: str
      ip6-max-interval:
        description: Deprecated, please rename it to ip6_max_interval.
        type: int
      ip6-min-interval:
        description: Deprecated, please rename it to ip6_min_interval.
        type: int
      ip6-mode:
        choices:
        - static
        - dhcp
        - pppoe
        - delegated
        description: Deprecated, please rename it to ip6_mode.
        type: str
      ip6-other-flag:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip6_other_flag.
        type: str
      ip6-prefix-list:
        description: Deprecated, please rename it to ip6_prefix_list.
        elements: dict
        suboptions:
          autonomous-flag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to autonomous_flag.
            type: str
          dnssl:
            description: (list) No description.
            type: raw
          onlink-flag:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to onlink_flag.
            type: str
          preferred-life-time:
            description: Deprecated, please rename it to preferred_life_time.
            type: int
          prefix:
            description: No description.
            type: str
          rdnss:
            description: (list) No description.
            type: raw
          valid-life-time:
            description: Deprecated, please rename it to valid_life_time.
            type: int
        type: list
      ip6-prefix-mode:
        choices:
        - dhcp6
        - ra
        description: Deprecated, please rename it to ip6_prefix_mode. Assigning a prefix
          from DHCP or RA.
        type: str
      ip6-reachable-time:
        description: Deprecated, please rename it to ip6_reachable_time.
        type: int
      ip6-retrans-time:
        description: Deprecated, please rename it to ip6_retrans_time.
        type: int
      ip6-send-adv:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip6_send_adv.
        type: str
      ip6-subnet:
        description: Deprecated, please rename it to ip6_subnet.
        type: str
      ip6-upstream-interface:
        description: Deprecated, please rename it to ip6_upstream_interface.
        type: str
      nd-cert:
        description: Deprecated, please rename it to nd_cert.
        type: str
      nd-cga-modifier:
        description: Deprecated, please rename it to nd_cga_modifier.
        type: str
      nd-mode:
        choices:
        - basic
        - SEND-compatible
        description: Deprecated, please rename it to nd_mode.
        type: str
      nd-security-level:
        description: Deprecated, please rename it to nd_security_level.
        type: int
      nd-timestamp-delta:
        description: Deprecated, please rename it to nd_timestamp_delta.
        type: int
      nd-timestamp-fuzz:
        description: Deprecated, please rename it to nd_timestamp_fuzz.
        type: int
      ra-send-mtu:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ra_send_mtu. Enable/disable sending
          link MTU in RA packet.
        type: str
      unique-autoconf-addr:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to unique_autoconf_addr.
        type: str
      vrip6_link_local:
        description: No description.
        type: str
      vrrp-virtual-mac6:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to vrrp_virtual_mac6.
        type: str
      vrrp6:
        description: No description.
        elements: dict
        suboptions:
          accept-mode:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to accept_mode.
            type: str
          adv-interval:
            description: Deprecated, please rename it to adv_interval.
            type: int
          preempt:
            choices:
            - disable
            - enable
            description: No description.
            type: str
          priority:
            description: No description.
            type: int
          start-time:
            description: Deprecated, please rename it to start_time.
            type: int
          status:
            choices:
            - disable
            - enable
            description: No description.
            type: str
          vrdst6:
            description: No description.
            type: str
          vrgrp:
            description: No description.
            type: int
          vrid:
            description: No description.
            type: int
          vrip6:
            description: No description.
            type: str
        type: list
    type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list