drmofu.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface_ipv6 (2.2.2) — module

IPv6 of interface.

| "added in version" 2.1.0 of drmofu.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 drmofu.fortimanager:==2.2.2


Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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.
 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: IPv6 of interface.
      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: <value of string>
            dhcp6-prefix-hint-plt: <value of integer>
            dhcp6-prefix-hint-vlt: <value of integer>
            dhcp6-relay-ip: <value of string>
            dhcp6-relay-service: <value in [disable, enable]>
            dhcp6-relay-type: <value in [regular]>
            ip6-address: <value of string>
            ip6-allowaccess:
              - https
              - ping
              - ssh
              - snmp
              - http
              - telnet
              - fgfm
              - capwap
              - fabric
            ip6-default-life: <value of integer>
            ip6-delegated-prefix-list:
              -
                  autonomous-flag: <value in [disable, enable]>
                  onlink-flag: <value in [disable, enable]>
                  prefix-id: <value of integer>
                  rdnss: <value of string>
                  rdnss-service: <value in [delegated, default, specify]>
                  subnet: <value of string>
                  upstream-interface: <value of string>
                  delegated-prefix-iaid: <value of integer>
            ip6-dns-server-override: <value in [disable, enable]>
            ip6-extra-addr:
              -
                  prefix: <value of string>
            ip6-hop-limit: <value of integer>
            ip6-link-mtu: <value of integer>
            ip6-manage-flag: <value in [disable, enable]>
            ip6-max-interval: <value of integer>
            ip6-min-interval: <value of 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: <value of string>
                  onlink-flag: <value in [disable, enable]>
                  preferred-life-time: <value of integer>
                  prefix: <value of string>
                  rdnss: <value of string>
                  valid-life-time: <value of integer>
            ip6-reachable-time: <value of integer>
            ip6-retrans-time: <value of integer>
            ip6-send-adv: <value in [disable, enable]>
            ip6-subnet: <value of string>
            ip6-upstream-interface: <value of string>
            nd-cert: <value of string>
            nd-cga-modifier: <value of string>
            nd-mode: <value in [basic, SEND-compatible]>
            nd-security-level: <value of integer>
            nd-timestamp-delta: <value of integer>
            nd-timestamp-fuzz: <value of integer>
            vrip6_link_local: <value of string>
            vrrp-virtual-mac6: <value in [disable, enable]>
            vrrp6:
              -
                  accept-mode: <value in [disable, enable]>
                  adv-interval: <value of integer>
                  preempt: <value in [disable, enable]>
                  priority: <value of integer>
                  start-time: <value of integer>
                  status: <value in [disable, enable]>
                  vrdst6: <value of string>
                  vrgrp: <value of integer>
                  vrid: <value of integer>
                  vrip6: <value of string>
            interface-identifier: <value of string>
            unique-autoconf-addr: <value in [disable, enable]>
            icmp6-send-redirect: <value in [disable, enable]>
            cli-conn6-status: <value of integer>
            ip6-prefix-mode: <value in [dhcp6, ra]>
            ra-send-mtu: <value in [disable, enable]>
            ip6-delegated-prefix-iaid: <value of 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
    required: false
    type: list

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

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

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    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.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    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: no description
        type: int
      dhcp6-client-options:
        choices:
        - rapid
        - iapd
        - iana
        - dns
        - dnsname
        description: description
        elements: str
        type: list
      dhcp6-information-request:
        choices:
        - disable
        - enable
        description: no description
        type: str
      dhcp6-prefix-delegation:
        choices:
        - disable
        - enable
        description: no description
        type: str
      dhcp6-prefix-hint:
        description: no description
        type: str
      dhcp6-prefix-hint-plt:
        description: no description
        type: int
      dhcp6-prefix-hint-vlt:
        description: no description
        type: int
      dhcp6-relay-ip:
        description: no description
        type: str
      dhcp6-relay-service:
        choices:
        - disable
        - enable
        description: no description
        type: str
      dhcp6-relay-source-interface:
        choices:
        - disable
        - enable
        description: Enable/disable use of address on this interface as the source address
          of the relay message.
        type: str
      dhcp6-relay-type:
        choices:
        - regular
        description: no description
        type: str
      icmp6-send-redirect:
        choices:
        - disable
        - enable
        description: Enable/disable sending of ICMPv6 redirects.
        type: str
      interface-identifier:
        description: no description
        type: str
      ip6-address:
        description: no description
        type: str
      ip6-allowaccess:
        choices:
        - https
        - ping
        - ssh
        - snmp
        - http
        - telnet
        - fgfm
        - capwap
        - fabric
        description: description
        elements: str
        type: list
      ip6-default-life:
        description: no description
        type: int
      ip6-delegated-prefix-iaid:
        description: IAID of obtained delegated-prefix from the upstream interface.
        type: int
      ip6-delegated-prefix-list:
        description: description
        elements: dict
        suboptions:
          autonomous-flag:
            choices:
            - disable
            - enable
            description: no description
            type: str
          delegated-prefix-iaid:
            description: IAID of obtained delegated-prefix from the upstream interface.
            type: int
          onlink-flag:
            choices:
            - disable
            - enable
            description: no description
            type: str
          prefix-id:
            description: no description
            type: int
          rdnss:
            description: description
            type: str
          rdnss-service:
            choices:
            - delegated
            - default
            - specify
            description: no description
            type: str
          subnet:
            description: no description
            type: str
          upstream-interface:
            description: no description
            type: str
        type: list
      ip6-dns-server-override:
        choices:
        - disable
        - enable
        description: no description
        type: str
      ip6-extra-addr:
        description: description
        elements: dict
        suboptions:
          prefix:
            description: no description
            type: str
        type: list
      ip6-hop-limit:
        description: no description
        type: int
      ip6-link-mtu:
        description: no description
        type: int
      ip6-manage-flag:
        choices:
        - disable
        - enable
        description: no description
        type: str
      ip6-max-interval:
        description: no description
        type: int
      ip6-min-interval:
        description: no description
        type: int
      ip6-mode:
        choices:
        - static
        - dhcp
        - pppoe
        - delegated
        description: no description
        type: str
      ip6-other-flag:
        choices:
        - disable
        - enable
        description: no description
        type: str
      ip6-prefix-list:
        description: description
        elements: dict
        suboptions:
          autonomous-flag:
            choices:
            - disable
            - enable
            description: no description
            type: str
          dnssl:
            description: description
            type: str
          onlink-flag:
            choices:
            - disable
            - enable
            description: no description
            type: str
          preferred-life-time:
            description: no description
            type: int
          prefix:
            description: no description
            type: str
          rdnss:
            description: description
            type: str
          valid-life-time:
            description: no description
            type: int
        type: list
      ip6-prefix-mode:
        choices:
        - dhcp6
        - ra
        description: Assigning a prefix from DHCP or RA.
        type: str
      ip6-reachable-time:
        description: no description
        type: int
      ip6-retrans-time:
        description: no description
        type: int
      ip6-send-adv:
        choices:
        - disable
        - enable
        description: no description
        type: str
      ip6-subnet:
        description: no description
        type: str
      ip6-upstream-interface:
        description: no description
        type: str
      nd-cert:
        description: no description
        type: str
      nd-cga-modifier:
        description: no description
        type: str
      nd-mode:
        choices:
        - basic
        - SEND-compatible
        description: no description
        type: str
      nd-security-level:
        description: no description
        type: int
      nd-timestamp-delta:
        description: no description
        type: int
      nd-timestamp-fuzz:
        description: no description
        type: int
      ra-send-mtu:
        choices:
        - disable
        - enable
        description: Enable/disable sending link MTU in RA packet.
        type: str
      unique-autoconf-addr:
        choices:
        - disable
        - enable
        description: no description
        type: str
      vrip6_link_local:
        description: no description
        type: str
      vrrp-virtual-mac6:
        choices:
        - disable
        - enable
        description: no description
        type: str
      vrrp6:
        description: description
        elements: dict
        suboptions:
          accept-mode:
            choices:
            - disable
            - enable
            description: no description
            type: str
          adv-interval:
            description: no description
            type: int
          preempt:
            choices:
            - disable
            - enable
            description: no description
            type: str
          priority:
            description: no description
            type: int
          start-time:
            description: no description
            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