fmgr_move – Reorder Two Objects.¶
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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- move - Reorder Two Objects. type: dict
- target - Key to the target entry. type: str required: true
- action - Direction to indicate where to move an object entry. type: str required: true choices: before, after
- selector - selector of the moved object type: str choices:
- dnsfilter_domainfilter_entries
- application_list_entries
- vpnsslweb_portal_bookmarkgroup
- vpnsslweb_portal_bookmarkgroup_bookmarks
- vpnsslweb_portal_splitdns
- pkg_firewall_centralsnatmap
- pkg_firewall_dospolicy
- pkg_firewall_dospolicy6
- pkg_firewall_interfacepolicy
- pkg_firewall_interfacepolicy6
- pkg_firewall_localinpolicy
- pkg_firewall_localinpolicy6
- pkg_firewall_multicastpolicy
- pkg_firewall_multicastpolicy6
- pkg_firewall_policy
- pkg_firewall_policy46
- pkg_firewall_policy6
- pkg_firewall_policy64
- pkg_firewall_proxypolicy
- pkg_firewall_shapingpolicy
- pkg_central_dnat
- webfilter_contentheader_entries
- webfilter_urlfilter_entries
- ips_sensor_entries
- ips_sensor_filter
- spamfilter_bwl_entries
- spamfilter_bword_entries
- firewall_carrierendpointbwl_entries
- firewall_identitybasedroute
- firewall_service_category
- firewall_service_custom
- firewall_shapingprofile_shapingentries
- firewall_vip
- system_sdnconnector_externalip
- system_sdnconnector_nic
- system_sdnconnector_nic_ip
- system_sdnconnector_routetable
- system_sdnconnector_routetable_route
- system_sdnconnector_route
- wanprof_system_virtualwanlink_members
- wanprof_system_virtualwanlink_service
- wanprof_system_virtualwanlink_service_sla
- sshfilter_profile_shellcommands
- bonjourprofile_policylist
- dlp_filepattern_entries
- dlp_sensor_filter
- self - the parameter for each selector type: dict choices:
- params for dnsfilter_domainfilter_entries:
- adom
- domain-filter
- entries
- params for application_list_entries:
- adom
- list
- entries
- params for vpnsslweb_portal_bookmarkgroup:
- adom
- portal
- bookmark-group
- params for vpnsslweb_portal_bookmarkgroup_bookmarks:
- adom
- portal
- bookmark-group
- bookmarks
- params for vpnsslweb_portal_splitdns:
- adom
- portal
- split-dns
- params for pkg_firewall_centralsnatmap:
- adom
- pkg
- central-snat-map
- params for pkg_firewall_dospolicy:
- adom
- pkg
- DoS-policy
- params for pkg_firewall_dospolicy6:
- adom
- pkg
- DoS-policy6
- params for pkg_firewall_interfacepolicy:
- adom
- pkg
- interface-policy
- params for pkg_firewall_interfacepolicy6:
- adom
- pkg
- interface-policy6
- params for pkg_firewall_localinpolicy:
- adom
- pkg
- local-in-policy
- params for pkg_firewall_localinpolicy6:
- adom
- pkg
- local-in-policy6
- params for pkg_firewall_multicastpolicy:
- adom
- pkg
- multicast-policy
- params for pkg_firewall_multicastpolicy6:
- adom
- pkg
- multicast-policy6
- 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_shapingpolicy:
- adom
- pkg
- shaping-policy
- params for pkg_central_dnat:
- adom
- pkg
- dnat
- params for webfilter_contentheader_entries:
- adom
- content-header
- entries
- params for webfilter_urlfilter_entries:
- adom
- urlfilter
- entries
- params for ips_sensor_entries:
- adom
- sensor
- entries
- params for ips_sensor_filter:
- adom
- sensor
- filter
- params for spamfilter_bwl_entries:
- adom
- bwl
- entries
- params for spamfilter_bword_entries:
- adom
- bword
- entries
- params for firewall_carrierendpointbwl_entries:
- adom
- carrier-endpoint-bwl
- entries
- params for firewall_identitybasedroute:
- adom
- identity-based-route
- params for firewall_service_category:
- adom
- category
- params for firewall_service_custom:
- adom
- custom
- params for firewall_shapingprofile_shapingentries:
- adom
- shaping-profile
- shaping-entries
- params for firewall_vip:
- adom
- vip
- params for system_sdnconnector_externalip:
- adom
- sdn-connector
- external-ip
- params for system_sdnconnector_nic:
- adom
- sdn-connector
- nic
- params for system_sdnconnector_nic_ip:
- adom
- sdn-connector
- nic
- ip
- params for system_sdnconnector_routetable:
- adom
- sdn-connector
- route-table
- params for system_sdnconnector_routetable_route:
- adom
- sdn-connector
- route-table
- route
- params for system_sdnconnector_route:
- adom
- sdn-connector
- route
- params for wanprof_system_virtualwanlink_members:
- adom
- wanprof
- members
- params for wanprof_system_virtualwanlink_service:
- adom
- wanprof
- service
- params for wanprof_system_virtualwanlink_service_sla:
- adom
- wanprof
- service
- sla
- params for sshfilter_profile_shellcommands:
- adom
- profile
- shell-commands
- params for bonjourprofile_policylist:
- adom
- bonjour-profile
- policy-list
- params for dlp_filepattern_entries:
- adom
- filepattern
- entries
- params for dlp_sensor_filter:
- adom
- sensor
- filter
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
selfaction(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¶
- hosts: fortimanager01
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Move a firewall vip object
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:
- 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