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

  • enable_log - Enable/Disable logging for task 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
  • 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 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • application_list_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • application_list_entries_parameters - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • vpnsslweb_portal_bookmarkgroup - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • vpnsslweb_portal_bookmarkgroup_bookmarks - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • vpnsslweb_portal_splitdns - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_centralsnatmap - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_dospolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_dospolicy6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_interfacepolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_interfacepolicy6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_localinpolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_localinpolicy6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_multicastpolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_multicastpolicy6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_policy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_policy46 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_policy6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0
      • pkg_firewall_policy64 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_proxypolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_shapingpolicy - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_central_dnat - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • webfilter_contentheader_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • webfilter_urlfilter_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • ips_sensor_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • ips_sensor_filter - available versions: 6.0.0
      • spamfilter_bwl_entries - available versions: 6.0.0
      • spamfilter_bword_entries - available versions: 6.0.0
      • firewall_carrierendpointbwl_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5
      • firewall_identitybasedroute - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • firewall_service_category - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • firewall_service_custom - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • firewall_shapingprofile_shapingentries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • firewall_vip - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • firewall_vip6 - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_externalip - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_nic - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_nic_ip - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_routetable - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_routetable_route - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • system_sdnconnector_route - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • wanprof_system_virtualwanlink_members - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0
      • wanprof_system_virtualwanlink_service - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0
      • wanprof_system_virtualwanlink_service_sla - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0
      • sshfilter_profile_shellcommands - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • bonjourprofile_policylist - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • dlp_filepattern_entries - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • dlp_sensor_filter - available versions: 6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • emailfilter_bword_entries - available versions: 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • emailfilter_bwl_entries - available versions: 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5
      • emailfilter_profile_filefilter_entries - available versions: 6.2.1 6.2.3 6.2.5 6.4.0
      • pkg_authentication_rule - available versions: 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • pkg_firewall_consolidated_policy - available versions: 6.2.1 6.2.3 6.2.5
      • pkg_firewall_securitypolicy - available versions: 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • cifs_profile_filefilter_entries - available versions: 6.2.1 6.2.3 6.2.5 6.4.0
      • application_list_defaultnetworkservices - available versions: 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
      • webfilter_profile_filefilter_entries - available versions: 6.2.1 6.2.3 6.2.5 6.4.0
      • sshfilter_profile_filefilter_entries - available versions: 6.2.3 6.2.5 6.4.0
      • mpskprofile_mpskgroup - available versions: 6.4.2 6.4.5 7.0.0
      • mpskprofile_mpskgroup_mpskkey - available versions: 6.4.2 6.4.5 7.0.0
      • filefilter_profile_rules - available versions: 6.4.2 6.4.5 7.0.0
      • vpn_ssl_settings_authenticationrule - available versions: 6.4.2
      • firewall_profileprotocoloptions_cifs_filefilter_entries - available versions: 6.4.2 6.4.5
      • pkg_central_dnat6 - available versions: 6.4.2 6.4.5 7.0.0
      • wanprof_system_sdwan_members - available versions: 6.4.2 6.4.5 7.0.0
      • wanprof_system_sdwan_service - available versions: 6.4.2 6.4.5 7.0.0
      • wanprof_system_sdwan_service_sla - available versions: 6.4.2 6.4.5 7.0.0
      • wanprof_system_sdwan_zone - available versions: 6.4.2 6.4.5 7.0.0
      • apcfgprofile_commandlist - available versions: 7.0.0
      • firewall_accessproxy - available versions: 7.0.0
      • videofilter_youtubechannelfilter_entries - available versions: 7.0.0
      • videofilter_profile_fortiguardcategory_filters - available versions: 7.0.0
      • emailfilter_blockallowlist_entries - available versions: 7.0.0
    • 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 application_list_entries_parameters:
        • adom
        • list
        • entries
        • parameters
      • 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 firewall_vip6:
        • adom
        • vip6
      • 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
      • params for emailfilter_bword_entries:
        • bword
        • entries
        • adom
      • params for emailfilter_bwl_entries:
        • bwl
        • entries
        • adom
      • params for emailfilter_profile_filefilter_entries:
        • profile
        • entries
        • adom
      • params for pkg_authentication_rule:
        • adom
        • pkg
        • rule
      • params for pkg_firewall_consolidated_policy:
        • adom
        • pkg
        • policy
      • params for pkg_firewall_securitypolicy:
        • adom
        • pkg
        • security-policy
      • params for cifs_profile_filefilter_entries:
        • profile
        • entries
        • adom
      • params for application_list_defaultnetworkservices:
        • list
        • default-network-services
        • adom
      • params for webfilter_profile_filefilter_entries:
        • profile
        • entries
        • adom
      • params for sshfilter_profile_filefilter_entries:
        • profile
        • entries
        • adom
      • params for mpskprofile_mpskgroup:
        • mpsk-profile
        • mpsk-group
        • adom
      • params for mpskprofile_mpskgroup_mpskkey:
        • mpsk-profile
        • mpsk-group
        • mpsk-key
        • adom
      • params for filefilter_profile_rules:
        • profile
        • rules
        • adom
      • params for vpn_ssl_settings_authenticationrule:
        • device
        • vdom
        • authentication-rule
      • params for firewall_profileprotocoloptions_cifs_filefilter_entries:
        • profile-protocol-options
        • entries
        • adom
      • params for pkg_central_dnat6:
        • adom
        • pkg
        • dnat6
      • params for wanprof_system_sdwan_members:
        • adom
        • wanprof
        • members
      • params for wanprof_system_sdwan_service:
        • adom
        • wanprof
        • service
      • params for wanprof_system_sdwan_service_sla:
        • adom
        • wanprof
        • service
        • sla
      • params for wanprof_system_sdwan_zone:
        • adom
        • wanprof
        • zone
      • params for apcfgprofile_commandlist:
        • apcfg-profile
        • command-list
        • adom
      • params for firewall_accessproxy:
        • access-proxy
        • adom
      • params for videofilter_youtubechannelfilter_entries:
        • youtube-channel-filter
        • entries
        • adom
      • params for videofilter_profile_fortiguardcategory_filters:
        • profile
        • filters
        • adom
      • params for emailfilter_blockallowlist_entries:
        • block-allow-list
        • entries
        • adom

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

- 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

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.