:source: fmgr_move.py
:orphan:
.. _fmgr_move:
fmgr_move -- Reorder Two Objects.
+++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
Parameters
----------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: strrequired: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: 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: integerrequired: falsedefault: 300
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
move - Reorder Two Objects. type: dict
action - Direction to indicate where to move an object entry. type: strrequired: true choices: before, after
selector - Selector of the moved object. type: strchoices:
apcfgprofile_commandlist - available versions:
v6.4.6->latest
application_casi_profile_entries - available versions:
v6.2.0->v6.2.13
application_list_defaultnetworkservices - available versions:
v6.2.0->latest
application_list_entries - available versions:
v6.0.0->latest
application_list_entries_parameters - available versions:
v6.0.0->latest
bonjourprofile_policylist - available versions:
v6.0.0->latest
casb_profile - available versions:
v7.4.1->latest
casb_saasapplication - available versions:
v7.4.1->latest
casb_useractivity - available versions:
v7.4.1->latest
cifs_profile_filefilter_entries - available versions:
v6.2.0->v7.6.2
dlp_dictionary_entries - available versions:
v7.2.0->latest
dlp_exactdatamatch_columns - available versions:
v7.4.7->v7.4.10,
v7.6.3->latest
dlp_filepattern_entries - available versions:
v6.0.0->latest
dlp_label_entries - available versions:
v7.6.3->latest
dlp_profile_rule - available versions:
v7.2.0->latest
dlp_sensor_entries - available versions:
v7.2.0->latest
dlp_sensor_filter - available versions:
v6.0.0->latest
dnsfilter_domainfilter_entries - available versions:
v6.0.0->latest
dnsfilter_urlfilter_entries - available versions:
v6.2.0->v6.2.13
emailfilter_blockallowlist_entries - available versions:
v7.0.0->latest
emailfilter_bwl_entries - available versions:
v6.2.0->latest
emailfilter_bword_entries - available versions:
v6.2.0->latest
emailfilter_profile_filefilter_entries - available versions:
v6.2.0->v7.6.2
endpointcontrol_fctems - available versions:
v7.0.2->latest
extendercontroller_extenderprofile_cellular_smsnotification_receiver - available versions:
v7.0.2->latest
extendercontroller_extenderprofile_lanextension_backhaul - available versions:
v7.0.2->latest
extensioncontroller_extenderprofile_cellular_smsnotification_receiver - available versions:
v7.2.1->latest
extensioncontroller_extenderprofile_lanextension_backhaul - available versions:
v7.2.1->latest
filefilter_profile_rules - available versions:
v6.4.1->latest
firewall_accessproxy - available versions:
v7.0.0->latest
firewall_accessproxy6 - available versions:
v7.2.1->latest
firewall_accessproxysshclientcert - available versions:
v7.4.2->latest
firewall_accessproxyvirtualhost - available versions:
v7.0.1->latest
firewall_carrierendpointbwl_entries - available versions:
v6.0.0->v7.6.2
firewall_casbprofile - available versions:
v7.4.1->v7.4.1
firewall_identitybasedroute - available versions:
v6.0.0->latest
firewall_profileprotocoloptions_cifs_filefilter_entries - available versions:
v6.4.2->latest
firewall_service_category - available versions:
v6.0.0->latest
firewall_service_custom - available versions:
v6.0.0->latest
firewall_shapingprofile_classes - available versions:
v7.4.8->v7.4.10,
v7.6.4->latest
firewall_shapingprofile_shapingentries - available versions:
v6.0.0->latest
firewall_vip - available versions:
v6.0.0->latest
firewall_vip6 - available versions:
v6.0.0->latest
ips_sensor_entries - available versions:
v6.0.0->latest
ips_sensor_filter - available versions:
v6.0.0->v6.2.0
isolator_profile_entries - available versions:
v7.6.4->latest
mpskprofile_mpskgroup - available versions:
v6.4.2->latest
mpskprofile_mpskgroup_mpskkey - available versions:
v6.4.2->latest
pkg_authentication_rule - available versions:
v6.2.1->latest
pkg_central_dnat - available versions:
v6.0.0->latest
pkg_central_dnat6 - available versions:
v6.4.2->latest
pkg_firewall_acl - available versions:
v7.2.0->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_acl6 - available versions:
v7.2.0->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_centralsnatmap - available versions:
v6.0.0->latest
pkg_firewall_consolidated_policy - available versions:
v6.2.0->v7.6.2
pkg_firewall_dospolicy - available versions:
v6.0.0->latest
pkg_firewall_dospolicy6 - available versions:
v6.0.0->latest
pkg_firewall_explicitproxypolicy - available versions:
v6.2.0->v6.2.13
pkg_firewall_explicitproxypolicy_identitybasedpolicy - available versions:
v6.2.0->v6.2.13
pkg_firewall_hyperscalepolicy - available versions:
v6.4.7->v6.4.15,
v7.0.1->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_hyperscalepolicy46 - available versions:
v6.4.7->v6.4.15,
v7.0.1->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_hyperscalepolicy6 - available versions:
v6.4.7->v6.4.15,
v7.0.1->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->v7.6.2
pkg_firewall_hyperscalepolicy64 - available versions:
v6.4.7->v6.4.15,
v7.0.1->v7.2.0,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_interfacepolicy - available versions:
v6.0.0->v7.2.2,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_interfacepolicy6 - available versions:
v6.0.0->v7.2.2,
v7.2.6->v7.2.12,
v7.4.3->latest
pkg_firewall_localinpolicy - available versions:
v6.0.0->latest
pkg_firewall_localinpolicy6 - available versions:
v6.0.0->latest
pkg_firewall_multicastpolicy - available versions:
v6.0.0->latest
pkg_firewall_multicastpolicy6 - available versions:
v6.0.0->latest
pkg_firewall_policy - available versions:
v6.0.0->latest
pkg_firewall_policy46 - available versions:
v6.0.0->latest
pkg_firewall_policy6 - available versions:
v6.0.0->v7.6.2
pkg_firewall_policy64 - available versions:
v6.0.0->latest
pkg_firewall_proxypolicy - available versions:
v6.0.0->latest
pkg_firewall_responseshapingpolicy - available versions:
v7.4.8->v7.4.10,
v7.6.4->latest
pkg_firewall_securitypolicy - available versions:
v6.2.1->latest
pkg_firewall_shapingpolicy - available versions:
v6.0.0->latest
pkg_user_nacpolicy - available versions:
v7.2.1->latest
pm_config_pblock_firewall_consolidated_policy - available versions:
v7.0.3->v7.6.2
pm_config_pblock_firewall_policy - available versions:
v7.0.3->latest
pm_config_pblock_firewall_policy6 - available versions:
v7.0.3->v7.6.2
pm_config_pblock_firewall_proxypolicy - available versions:
v7.6.0->latest
pm_config_pblock_firewall_securitypolicy - available versions:
v7.0.3->latest
spamfilter_bwl_entries - available versions:
v6.0.0->v7.2.1,
v7.4.8->v7.4.10
spamfilter_bword_entries - available versions:
v6.0.0->v7.2.1,
v7.4.8->v7.4.10
sshfilter_profile_filefilter_entries - available versions:
v6.2.2->v7.6.2
sshfilter_profile_shellcommands - available versions:
v6.0.0->latest
switchcontroller_dynamicportpolicy_policy - available versions:
v7.2.1->latest
switchcontroller_managedswitch - available versions:
v6.0.0->latest
system_externalresource - available versions:
v6.0.0->latest
system_sdnconnector_compartmentlist - available versions:
v7.4.0->latest
system_sdnconnector_externalaccountlist - available versions:
v7.0.3->latest
system_sdnconnector_externalip - available versions:
v6.0.0->latest
system_sdnconnector_forwardingrule - available versions:
v7.0.2->latest
system_sdnconnector_gcpprojectlist - available versions:
v6.4.7->v6.4.15,
v7.0.2->latest
system_sdnconnector_nic - available versions:
v6.0.0->latest
system_sdnconnector_nic_ip - available versions:
v6.0.0->latest
system_sdnconnector_ociregionlist - available versions:
v7.4.0->latest
system_sdnconnector_route - available versions:
v6.0.0->latest
system_sdnconnector_routetable - available versions:
v6.0.0->latest
system_sdnconnector_routetable_route - available versions:
v6.0.0->latest
user_deviceaccesslist_devicelist - available versions:
v6.2.2->v7.2.1
vap_vlanname - available versions:
v7.0.3->latest
videofilter_profile_filters - available versions:
v7.4.2->latest
videofilter_profile_fortiguardcategory_filters - available versions:
v7.0.0->latest
videofilter_youtubechannelfilter_entries - available versions:
v7.0.0->latest
vpn_ipsec_fec_mappings - available versions:
v7.2.0->latest
vpn_kmipserver_serverlist - available versions:
v7.6.4->latest
vpn_ssl_settings_authenticationrule - available versions:
v6.2.6->v6.2.13,
v6.4.2->latest
vpnsslweb_portal_bookmarkgroup - available versions:
v6.0.0->latest
vpnsslweb_portal_bookmarkgroup_bookmarks - available versions:
v6.0.0->latest
vpnsslweb_portal_splitdns - available versions:
v6.0.0->latest
wanprof_system_sdwan_members - available versions:
v6.4.1->latest
wanprof_system_sdwan_service - available versions:
v6.4.1->latest
wanprof_system_sdwan_service_sla - available versions:
v6.4.1->latest
wanprof_system_sdwan_zone - available versions:
v6.4.1->latest
wanprof_system_virtualwanlink_members - available versions:
v6.0.0->v7.6.2
wanprof_system_virtualwanlink_service - available versions:
v6.0.0->v7.6.2
wanprof_system_virtualwanlink_service_sla - available versions:
v6.0.0->v7.6.2
webfilter_contentheader_entries - available versions:
v6.0.0->latest
webfilter_profile_filefilter_entries - available versions:
v6.2.0->v7.6.2
webfilter_urlfilter_entries - available versions:
v6.0.0->latest
webproxy_redirectprofile_entries - available versions:
v7.6.4->latest
wireless_accesscontrollist_layer3ipv4rules - available versions:
v7.2.1->latest
wireless_accesscontrollist_layer3ipv6rules - available versions:
v7.2.1->latest
ztna_webportalbookmark_bookmarks - available versions:
v7.6.4->latest
self - The parameter for each selector. type: dictchoices:
params for apcfgprofile_commandlist:
adom
apcfg-profile
command-list
params for application_casi_profile_entries:
adom
entries
profile
params for application_list_defaultnetworkservices:
adom
default-network-services
list
params for application_list_entries:
adom
entries
list
params for application_list_entries_parameters:
adom
entries
list
parameters
params for bonjourprofile_policylist:
adom
bonjour-profile
policy-list
params for casb_profile:
adom
profile
params for casb_saasapplication:
adom
saas-application
params for casb_useractivity:
adom
user-activity
params for cifs_profile_filefilter_entries:
adom
entries
profile
params for dlp_dictionary_entries:
adom
dictionary
entries
params for dlp_exactdatamatch_columns:
adom
columns
exact-data-match
params for dlp_filepattern_entries:
adom
entries
filepattern
params for dlp_label_entries:
adom
entries
label
params for dlp_profile_rule:
adom
profile
rule
params for dlp_sensor_entries:
adom
entries
sensor
params for dlp_sensor_filter:
adom
filter
sensor
params for dnsfilter_domainfilter_entries:
adom
domain-filter
entries
params for dnsfilter_urlfilter_entries:
adom
entries
urlfilter
params for emailfilter_blockallowlist_entries:
adom
block-allow-list
entries
params for emailfilter_bwl_entries:
adom
bwl
entries
params for emailfilter_bword_entries:
adom
bword
entries
params for emailfilter_profile_filefilter_entries:
adom
entries
profile
params for endpointcontrol_fctems:
adom
fctems
params for extendercontroller_extenderprofile_cellular_smsnotification_receiver:
adom
extender-profile
receiver
params for extendercontroller_extenderprofile_lanextension_backhaul:
adom
backhaul
extender-profile
params for extensioncontroller_extenderprofile_cellular_smsnotification_receiver:
adom
extender-profile
receiver
params for extensioncontroller_extenderprofile_lanextension_backhaul:
adom
backhaul
extender-profile
params for filefilter_profile_rules:
adom
profile
rules
params for firewall_accessproxy:
access-proxy
adom
params for firewall_accessproxy6:
access-proxy6
adom
params for firewall_accessproxysshclientcert:
access-proxy-ssh-client-cert
adom
params for firewall_accessproxyvirtualhost:
access-proxy-virtual-host
adom
params for firewall_carrierendpointbwl_entries:
adom
carrier-endpoint-bwl
entries
params for firewall_casbprofile:
adom
casb-profile
params for firewall_identitybasedroute:
adom
identity-based-route
params for firewall_profileprotocoloptions_cifs_filefilter_entries:
adom
entries
profile-protocol-options
params for firewall_service_category:
adom
category
params for firewall_service_custom:
adom
custom
params for firewall_shapingprofile_classes:
adom
classes
shaping-profile
params for firewall_shapingprofile_shapingentries:
adom
shaping-entries
shaping-profile
params for firewall_vip:
adom
vip
params for firewall_vip6:
adom
vip6
params for ips_sensor_entries:
adom
entries
sensor
params for ips_sensor_filter:
adom
filter
sensor
params for isolator_profile_entries:
adom
entries
profile
params for mpskprofile_mpskgroup:
adom
mpsk-group
mpsk-profile
params for mpskprofile_mpskgroup_mpskkey:
adom
mpsk-group
mpsk-key
mpsk-profile
params for pkg_authentication_rule:
adom
pkg
rule
params for pkg_central_dnat:
adom
dnat
pkg
params for pkg_central_dnat6:
adom
dnat6
pkg
params for pkg_firewall_acl:
acl
adom
pkg
params for pkg_firewall_acl6:
acl6
adom
pkg
params for pkg_firewall_centralsnatmap:
adom
central-snat-map
pkg
params for pkg_firewall_consolidated_policy:
adom
pkg
policy
params for pkg_firewall_dospolicy:
DoS-policy
adom
pkg
params for pkg_firewall_dospolicy6:
DoS-policy6
adom
pkg
params for pkg_firewall_explicitproxypolicy:
adom
explicit-proxy-policy
pkg
params for pkg_firewall_explicitproxypolicy_identitybasedpolicy:
adom
explicit-proxy-policy
identity-based-policy
pkg
params for pkg_firewall_hyperscalepolicy:
adom
hyperscale-policy
pkg
params for pkg_firewall_hyperscalepolicy46:
adom
hyperscale-policy46
pkg
params for pkg_firewall_hyperscalepolicy6:
adom
hyperscale-policy6
pkg
params for pkg_firewall_hyperscalepolicy64:
adom
hyperscale-policy64
pkg
params for pkg_firewall_interfacepolicy:
adom
interface-policy
pkg
params for pkg_firewall_interfacepolicy6:
adom
interface-policy6
pkg
params for pkg_firewall_localinpolicy:
adom
local-in-policy
pkg
params for pkg_firewall_localinpolicy6:
adom
local-in-policy6
pkg
params for pkg_firewall_multicastpolicy:
adom
multicast-policy
pkg
params for pkg_firewall_multicastpolicy6:
adom
multicast-policy6
pkg
params for pkg_firewall_policy:
adom
pkg
policy
params for pkg_firewall_policy46:
adom
pkg
policy46
params for pkg_firewall_policy6:
adom
pkg
policy6
params for pkg_firewall_policy64:
adom
pkg
policy64
params for pkg_firewall_proxypolicy:
adom
pkg
proxy-policy
params for pkg_firewall_responseshapingpolicy:
adom
pkg
response-shaping-policy
params for pkg_firewall_securitypolicy:
adom
pkg
security-policy
params for pkg_firewall_shapingpolicy:
adom
pkg
shaping-policy
params for pkg_user_nacpolicy:
adom
nac-policy
pkg
params for pm_config_pblock_firewall_consolidated_policy:
adom
pblock
policy
params for pm_config_pblock_firewall_policy:
adom
pblock
policy
params for pm_config_pblock_firewall_policy6:
adom
pblock
policy6
params for pm_config_pblock_firewall_proxypolicy:
adom
pblock
proxy-policy
params for pm_config_pblock_firewall_securitypolicy:
adom
pblock
security-policy
params for spamfilter_bwl_entries:
adom
bwl
entries
params for spamfilter_bword_entries:
adom
bword
entries
params for sshfilter_profile_filefilter_entries:
adom
entries
profile
params for sshfilter_profile_shellcommands:
adom
profile
shell-commands
params for switchcontroller_dynamicportpolicy_policy:
adom
dynamic-port-policy
policy
params for switchcontroller_managedswitch:
adom
managed-switch
params for system_externalresource:
adom
external-resource
params for system_sdnconnector_compartmentlist:
adom
compartment-list
sdn-connector
params for system_sdnconnector_externalaccountlist:
adom
external-account-list
sdn-connector
params for system_sdnconnector_externalip:
adom
external-ip
sdn-connector
params for system_sdnconnector_forwardingrule:
adom
forwarding-rule
sdn-connector
params for system_sdnconnector_gcpprojectlist:
adom
gcp-project-list
sdn-connector
params for system_sdnconnector_nic:
adom
nic
sdn-connector
params for system_sdnconnector_nic_ip:
adom
ip
nic
sdn-connector
params for system_sdnconnector_ociregionlist:
adom
oci-region-list
sdn-connector
params for system_sdnconnector_route:
adom
route
sdn-connector
params for system_sdnconnector_routetable:
adom
route-table
sdn-connector
params for system_sdnconnector_routetable_route:
adom
route
route-table
sdn-connector
params for user_deviceaccesslist_devicelist:
adom
device-access-list
device-list
params for vap_vlanname:
adom
vap
vlan-name
params for videofilter_profile_filters:
adom
filters
profile
params for videofilter_profile_fortiguardcategory_filters:
adom
filters
profile
params for videofilter_youtubechannelfilter_entries:
adom
entries
youtube-channel-filter
params for vpn_ipsec_fec_mappings:
adom
fec
mappings
params for vpn_kmipserver_serverlist:
adom
kmip-server
server-list
params for vpn_ssl_settings_authenticationrule:
authentication-rule
device
vdom
params for vpnsslweb_portal_bookmarkgroup:
adom
bookmark-group
portal
params for vpnsslweb_portal_bookmarkgroup_bookmarks:
adom
bookmark-group
bookmarks
portal
params for vpnsslweb_portal_splitdns:
adom
portal
split-dns
params for wanprof_system_sdwan_members:
adom
members
wanprof
params for wanprof_system_sdwan_service:
adom
service
wanprof
params for wanprof_system_sdwan_service_sla:
adom
service
sla
wanprof
params for wanprof_system_sdwan_zone:
adom
wanprof
zone
params for wanprof_system_virtualwanlink_members:
adom
members
wanprof
params for wanprof_system_virtualwanlink_service:
adom
service
wanprof
params for wanprof_system_virtualwanlink_service_sla:
adom
service
sla
wanprof
params for webfilter_contentheader_entries:
adom
content-header
entries
params for webfilter_profile_filefilter_entries:
adom
entries
profile
params for webfilter_urlfilter_entries:
adom
entries
urlfilter
params for webproxy_redirectprofile_entries:
adom
entries
redirect-profile
params for wireless_accesscontrollist_layer3ipv4rules:
access-control-list
adom
layer3-ipv4-rules
params for wireless_accesscontrollist_layer3ipv6rules:
access-control-list
adom
layer3-ipv6-rules
params for ztna_webportalbookmark_bookmarks:
adom
bookmarks
web-portal-bookmark
target - Key to the target entry. type: strrequired: true
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.
- Selector is a mandatory parameter for the module, and the params is varying depending on the selector.
- Semantic description for the module: move ``self`` ``action(before or after)`` ``target``
- 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
--------
.. code-block:: yaml+jinja
- name: Move an object
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Move a firewall vip object
fortinet.fortimanager.fmgr_move:
move:
selector: "firewall_vip"
target: "ansible-test-vip_first"
action: "before"
self:
adom: "root"
vip: "ansible-test-vip_second"
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:
.. raw:: html
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: int0
version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager versiontype: list0
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- 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.