W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_fsp_vlan_dynamicmapping_interface – no description

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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_dynamicmapping_interface.

New in version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
dynamic_mapping
string / required
the parameter (dynamic_mapping) in requested url
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
fsp_vlan_dynamicmapping_interface
dictionary
the top level parameters set
dhcp-relay-agent-option
string
    Choices:
  • disable
  • enable
no description
dhcp-relay-ip
string
no description
dhcp-relay-service
string
    Choices:
  • disable
  • enable
no description
dhcp-relay-type
string
    Choices:
  • regular
  • ipsec
no description
ip
string
no description
ipv6
dictionary
no description
autoconf
string
    Choices:
  • disable
  • enable
no description
cli-conn6-status
integer
no description
dhcp6-client-options
list / elements=string
    Choices:
  • rapid
  • iapd
  • iana
  • dns
  • dnsname
no description
dhcp6-information-request
string
    Choices:
  • disable
  • enable
no description
dhcp6-prefix-delegation
string
    Choices:
  • disable
  • enable
no description
dhcp6-prefix-hint
string
no description
dhcp6-prefix-hint-plt
integer
no description
dhcp6-prefix-hint-vlt
integer
no description
dhcp6-relay-ip
string
no description
dhcp6-relay-service
string
    Choices:
  • disable
  • enable
no description
dhcp6-relay-type
string
    Choices:
  • regular
no description
icmp6-send-redirect
string
    Choices:
  • disable
  • enable
Enable/disable sending of ICMPv6 redirects.
interface-identifier
string
no description
ip6-address
string
no description
ip6-allowaccess
list / elements=string
    Choices:
  • https
  • ping
  • ssh
  • snmp
  • http
  • telnet
  • fgfm
  • capwap
  • fabric
no description
ip6-default-life
integer
no description
ip6-delegated-prefix-list
list / elements=string
no description
autonomous-flag
string
    Choices:
  • disable
  • enable
no description
onlink-flag
string
    Choices:
  • disable
  • enable
no description
prefix-id
integer
no description
rdnss
string
no description
rdnss-service
string
    Choices:
  • delegated
  • default
  • specify
no description
subnet
string
no description
upstream-interface
string
no description
ip6-dns-server-override
string
    Choices:
  • disable
  • enable
no description
ip6-extra-addr
list / elements=string
no description
prefix
string
no description
ip6-hop-limit
integer
no description
ip6-link-mtu
integer
no description
ip6-manage-flag
string
    Choices:
  • disable
  • enable
no description
ip6-max-interval
integer
no description
ip6-min-interval
integer
no description
ip6-mode
string
    Choices:
  • static
  • dhcp
  • pppoe
  • delegated
no description
ip6-other-flag
string
    Choices:
  • disable
  • enable
no description
ip6-prefix-list
list / elements=string
no description
autonomous-flag
string
    Choices:
  • disable
  • enable
no description
dnssl
string
no description
onlink-flag
string
    Choices:
  • disable
  • enable
no description
preferred-life-time
integer
no description
prefix
string
no description
rdnss
string
no description
valid-life-time
integer
no description
ip6-prefix-mode
string
    Choices:
  • dhcp6
  • ra
Assigning a prefix from DHCP or RA.
ip6-reachable-time
integer
no description
ip6-retrans-time
integer
no description
ip6-send-adv
string
    Choices:
  • disable
  • enable
no description
ip6-subnet
string
no description
ip6-upstream-interface
string
no description
nd-cert
string
no description
nd-cga-modifier
string
no description
nd-mode
string
    Choices:
  • basic
  • SEND-compatible
no description
nd-security-level
integer
no description
nd-timestamp-delta
integer
no description
nd-timestamp-fuzz
integer
no description
ra-send-mtu
string
    Choices:
  • disable
  • enable
Enable/disable sending link MTU in RA packet.
unique-autoconf-addr
string
    Choices:
  • disable
  • enable
no description
vrip6_link_local
string
no description
vrrp-virtual-mac6
string
    Choices:
  • disable
  • enable
no description
vrrp6
list / elements=string
no description
accept-mode
string
    Choices:
  • disable
  • enable
no description
adv-interval
integer
no description
preempt
string
    Choices:
  • disable
  • enable
no description
priority
integer
no description
start-time
integer
no description
status
string
    Choices:
  • disable
  • enable
no description
vrdst6
string
no description
vrgrp
integer
no description
vrid
integer
no description
vrip6
string
no description
secondary-IP
string
    Choices:
  • disable
  • enable
no description
secondaryip
list / elements=string
no description
allowaccess
list / elements=string
    Choices:
  • https
  • ping
  • ssh
  • snmp
  • http
  • telnet
  • fgfm
  • auto-ipsec
  • radius-acct
  • probe-response
  • capwap
  • dnp
  • ftm
  • fabric
no description
detectprotocol
list / elements=string
    Choices:
  • ping
  • tcp-echo
  • udp-echo
no description
detectserver
string
no description
gwdetect
string
    Choices:
  • disable
  • enable
no description
ha-priority
integer
no description
id
integer
no description
ip
string
no description
ping-serv-status
integer
no description
seq
integer
no description
vlanid
integer
no description
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_fsp_vlan_dynamicmapping_interface_module.html