fmgr_fsp_vlan_dynamicmapping_interface

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
fsp_vlan_dynamicmapping_interface yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • vlan - The parameter in requested url type: str required: true
  • dynamic_mapping - The parameter in requested url type: str required: true
  • fsp_vlan_dynamicmapping_interface - no description type: dict
    • ip - No description for the parameter type: str more...
    • vlanid - No description for the parameter type: int more...
    • dhcp-relay-agent-option - No description for the parameter type: str choices: [disable, enable] more...
    • dhcp-relay-ip - No description for the parameter type: str more...
    • dhcp-relay-service - No description for the parameter type: str choices: [disable, enable] more...
    • dhcp-relay-type - No description for the parameter type: str choices: [regular, ipsec] more...
    • ipv6 type: dict
      • autoconf - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-client-options - No description for the parameter type: array choices: [rapid, iapd, iana, dns, dnsname] more...
      • dhcp6-information-request - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-prefix-delegation - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-prefix-hint - No description for the parameter type: str more...
      • dhcp6-prefix-hint-plt - No description for the parameter type: int more...
      • dhcp6-prefix-hint-vlt - No description for the parameter type: int more...
      • dhcp6-relay-ip - No description for the parameter type: str more...
      • dhcp6-relay-service - No description for the parameter type: str choices: [disable, enable] more...
      • dhcp6-relay-type - No description for the parameter type: str choices: [regular] more...
      • ip6-address - No description for the parameter type: str more...
      • ip6-allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric] more...
      • ip6-default-life - No description for the parameter type: int more...
      • ip6-delegated-prefix-list - No description for the parameter type: array more...
        • autonomous-flag - No description for the parameter type: str choices: [disable, enable] more...
        • onlink-flag - No description for the parameter type: str choices: [disable, enable] more...
        • prefix-id - No description for the parameter type: int more...
        • rdnss - No description for the parameter type: str more...
        • rdnss-service - No description for the parameter type: str choices: [delegated, default, specify] more...
        • subnet - No description for the parameter type: str more...
        • upstream-interface - No description for the parameter type: str more...
        • delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
      • ip6-dns-server-override - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-extra-addr - No description for the parameter type: array more...
        • prefix - No description for the parameter type: str more...
      • ip6-hop-limit - No description for the parameter type: int more...
      • ip6-link-mtu - No description for the parameter type: int more...
      • ip6-manage-flag - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-max-interval - No description for the parameter type: int more...
      • ip6-min-interval - No description for the parameter type: int more...
      • ip6-mode - No description for the parameter type: str choices: [static, dhcp, pppoe, delegated] more...
      • ip6-other-flag - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-prefix-list - No description for the parameter type: array more...
        • autonomous-flag - No description for the parameter type: str choices: [disable, enable] more...
        • dnssl - No description for the parameter type: str more...
        • onlink-flag - No description for the parameter type: str choices: [disable, enable] more...
        • preferred-life-time - No description for the parameter type: int more...
        • prefix - No description for the parameter type: str more...
        • rdnss - No description for the parameter type: str more...
        • valid-life-time - No description for the parameter type: int more...
      • ip6-reachable-time - No description for the parameter type: int more...
      • ip6-retrans-time - No description for the parameter type: int more...
      • ip6-send-adv - No description for the parameter type: str choices: [disable, enable] more...
      • ip6-subnet - No description for the parameter type: str more...
      • ip6-upstream-interface - No description for the parameter type: str more...
      • nd-cert - No description for the parameter type: str more...
      • nd-cga-modifier - No description for the parameter type: str more...
      • nd-mode - No description for the parameter type: str choices: [basic, SEND-compatible] more...
      • nd-security-level - No description for the parameter type: int more...
      • nd-timestamp-delta - No description for the parameter type: int more...
      • nd-timestamp-fuzz - No description for the parameter type: int more...
      • vrip6_link_local - No description for the parameter type: str more...
      • vrrp-virtual-mac6 - No description for the parameter type: str choices: [disable, enable] more...
      • vrrp6 - No description for the parameter type: array more...
        • accept-mode - No description for the parameter type: str choices: [disable, enable] more...
        • adv-interval - No description for the parameter type: int more...
        • preempt - No description for the parameter type: str choices: [disable, enable] more...
        • priority - No description for the parameter type: int more...
        • start-time - No description for the parameter type: int more...
        • status - No description for the parameter type: str choices: [disable, enable] more...
        • vrdst6 - No description for the parameter type: str more...
        • vrgrp - No description for the parameter type: int more...
        • vrid - No description for the parameter type: int more...
        • vrip6 - No description for the parameter type: str more...
      • interface-identifier - No description for the parameter type: str more...
      • unique-autoconf-addr - No description for the parameter type: str choices: [disable, enable] more...
      • icmp6-send-redirect - Enable/disable sending of ICMPv6 redirects. type: str choices: [disable, enable] more...
      • cli-conn6-status - No description for the parameter type: int more...
      • ip6-prefix-mode - Assigning a prefix from DHCP or RA. type: str choices: [dhcp6, ra] more...
      • ra-send-mtu - Enable/disable sending link MTU in RA packet. type: str choices: [disable, enable] more...
      • ip6-delegated-prefix-iaid - IAID of obtained delegated-prefix from the upstream interface. type: int more...
    • secondary-IP - No description for the parameter type: str choices: [disable, enable] more...
    • secondaryip - No description for the parameter type: array more...
      • allowaccess - No description for the parameter type: array choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test] more...
      • detectprotocol - No description for the parameter type: array choices: [ping, tcp-echo, udp-echo] more...
      • detectserver - No description for the parameter type: str more...
      • gwdetect - No description for the parameter type: str choices: [disable, enable] more...
      • ha-priority - No description for the parameter type: int more...
      • id - No description for the parameter type: int more...
      • ip - No description for the parameter type: str more...
      • ping-serv-status - No description for the parameter type: int more...
      • seq - No description for the parameter type: int more...
    • dhcp-relay-interface-select-method - No description for the parameter type: str choices: [auto, sdwan, specify] 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

- 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: no description
     fmgr_fsp_vlan_dynamicmapping_interface:
        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:
           ip: <value of string>
           vlanid: <value of integer>
           dhcp-relay-agent-option: <value in [disable, enable]>
           dhcp-relay-ip: <value of string>
           dhcp-relay-service: <value in [disable, enable]>
           dhcp-relay-type: <value in [regular, ipsec]>
           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>
           secondary-IP: <value in [disable, enable]>
           secondaryip:
             -
                 allowaccess:
                   - https
                   - ping
                   - ssh
                   - snmp
                   - http
                   - telnet
                   - fgfm
                   - auto-ipsec
                   - radius-acct
                   - probe-response
                   - capwap
                   - dnp
                   - ftm
                   - fabric
                   - speed-test
                 detectprotocol:
                   - ping
                   - tcp-echo
                   - udp-echo
                 detectserver: <value of string>
                 gwdetect: <value in [disable, enable]>
                 ha-priority: <value of integer>
                 id: <value of integer>
                 ip: <value of string>
                 ping-serv-status: <value of integer>
                 seq: <value of integer>
           dhcp-relay-interface-select-method: <value in [auto, sdwan, specify]>

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.