- source
fmgr_fsp_vlan_interface_ipv6.py
- orphan
2.0.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.0.0 -> latest
- 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
- adom - The parameter in requested url type: str required: true
- vlan - The parameter in requested url type: str required: true
- fsp_vlan_interface_ipv6 - IPv6 of interface. type: dict
- autoconf type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_client_options (Alias name: dhcp6-client-options) type: list choices: [rapid, iapd, iana, dns, dnsname]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_information_request (Alias name: dhcp6-information-request) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_relay_ip (Alias name: dhcp6-relay-ip) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_relay_service (Alias name: dhcp6-relay-service) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- dhcp6_relay_type (Alias name: dhcp6-relay-type) type: str choices: [regular]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_address (Alias name: ip6-address) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_allowaccess (Alias name: ip6-allowaccess) type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_default_life (Alias name: ip6-default-life) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_dns_server_override (Alias name: ip6-dns-server-override) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_hop_limit (Alias name: ip6-hop-limit) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_link_mtu (Alias name: ip6-link-mtu) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_manage_flag (Alias name: ip6-manage-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_max_interval (Alias name: ip6-max-interval) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_min_interval (Alias name: ip6-min-interval) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_mode (Alias name: ip6-mode) type: str choices: [static, dhcp, pppoe, delegated]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_other_flag (Alias name: ip6-other-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_reachable_time (Alias name: ip6-reachable-time) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_retrans_time (Alias name: ip6-retrans-time) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_send_adv (Alias name: ip6-send-adv) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_subnet (Alias name: ip6-subnet) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_upstream_interface (Alias name: ip6-upstream-interface) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_cert (Alias name: nd-cert) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_cga_modifier (Alias name: nd-cga-modifier) type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_mode (Alias name: nd-mode) type: str choices: [basic, SEND-compatible]
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_security_level (Alias name: nd-security-level) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_timestamp_delta (Alias name: nd-timestamp-delta) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) type: int
more...
Supported Version Ranges:
v6.0.0 -> latest
- vrip6_link_local type: str
more...
Supported Version Ranges:
v6.0.0 -> latest
- vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> latest
- ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- onlink_flag (Alias name: onlink-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- prefix_id (Alias name: prefix-id) type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- rdnss type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- rdnss_service (Alias name: rdnss-service) type: str choices: [delegated, default, specify]
more...
Supported Version Ranges:
v6.2.2 -> latest
- subnet type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- upstream_interface (Alias name: upstream-interface) type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable]
more...
- ip6_extra_addr (Alias name: ip6-extra-addr) type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- prefix type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- prefix type: str
more...
- ip6_prefix_list (Alias name: ip6-prefix-list) type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- dnssl type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- onlink_flag (Alias name: onlink-flag) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- preferred_life_time (Alias name: preferred-life-time) type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- prefix type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- rdnss type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- valid_life_time (Alias name: valid-life-time) type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- autonomous_flag (Alias name: autonomous-flag) type: str choices: [disable, enable]
more...
- vrrp6 type: list
more...
Supported Version Ranges:
v6.2.2 -> latest
- accept_mode (Alias name: accept-mode) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- adv_interval (Alias name: adv-interval) type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- preempt type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- priority type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- start_time (Alias name: start-time) type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- status type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.2 -> latest
- vrdst6 type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- vrgrp type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- vrid type: int
more...
Supported Version Ranges:
v6.2.2 -> latest
- vrip6 type: str
more...
Supported Version Ranges:
v6.2.2 -> latest
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- accept_mode (Alias name: accept-mode) type: str choices: [disable, enable]
more...
- interface_identifier (Alias name: interface-identifier) type: str
more...
Supported Version Ranges:
v6.4.1 -> latest
- unique_autoconf_addr (Alias name: unique-autoconf-addr) type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.1 -> latest
- icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.4 -> latest
- cli_conn6_status (Alias name: cli-conn6-status) type: int
more...
Supported Version Ranges:
v7.0.0 -> latest
- ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra]
more...
Supported Version Ranges:
v7.0.0 -> latest
- ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.4.6 -> latest
- ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- 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...
Supported Version Ranges:
v7.2.2 -> latest
- dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest
- dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str
more...
Supported Version Ranges:
v7.4.1 -> latest
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
- 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_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>
fsp_vlan_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_dns_server_override: <value in [disable, enable]>
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_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]>
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_extra_addr:
-
prefix: <string>
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>
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>
ignore_default_route: <value in [disable, enable]>
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]>
dhcp6_relay_interface_id: <string>
dhcp6_relay_source_ip: <string>
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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)