fortinet.fortimanager.fmgr_move 模块 – 移动 FortiManager 定义的对象。

注意

此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。

如果您使用的是 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager

要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_move

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括在使用前需要调整到数据源的所有参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ←(默认)

  • true

forticloud_access_token

字符串

FortiCloud 管理 API 用户的访问令牌,此选项在 FortiManager 6.4.0 或更高版本中可用。

move

字典 / 必需

重新排序两个对象。

action

字符串 / 必需

指示移动对象条目方向的指令。

选项

  • “after”

  • “before”

selector

字符串 / 必需

移动对象的选择器。

选项

  • “apcfgprofile_commandlist”

  • “application_casi_profile_entries”

  • “application_list_defaultnetworkservices”

  • “application_list_entries”

  • “application_list_entries_parameters”

  • “bonjourprofile_policylist”

  • “casb_profile”

  • “casb_saasapplication”

  • “casb_useractivity”

  • “cifs_profile_filefilter_entries”

  • “dlp_dictionary_entries”

  • “dlp_filepattern_entries”

  • “dlp_profile_rule”

  • “dlp_sensor_entries”

  • “dlp_sensor_filter”

  • “dnsfilter_domainfilter_entries”

  • “dnsfilter_urlfilter_entries”

  • “emailfilter_blockallowlist_entries”

  • “emailfilter_bwl_entries”

  • “emailfilter_bword_entries”

  • “emailfilter_profile_filefilter_entries”

  • “endpointcontrol_fctems”

  • “extendercontroller_extenderprofile_cellular_smsnotification_receiver”

  • “extendercontroller_extenderprofile_lanextension_backhaul”

  • “extensioncontroller_extenderprofile_cellular_smsnotification_receiver”

  • “extensioncontroller_extenderprofile_lanextension_backhaul”

  • “filefilter_profile_rules”

  • “firewall_accessproxy”

  • “firewall_accessproxy6”

  • “firewall_accessproxysshclientcert”

  • “firewall_accessproxyvirtualhost”

  • “firewall_carrierendpointbwl_entries”

  • “firewall_casbprofile”

  • “firewall_identitybasedroute”

  • “firewall_profileprotocoloptions_cifs_filefilter_entries”

  • “firewall_service_category”

  • “firewall_service_custom”

  • “firewall_shapingprofile_shapingentries”

  • “firewall_vip”

  • “firewall_vip6”

  • “ips_sensor_entries”

  • “ips_sensor_filter”

  • “mpskprofile_mpskgroup”

  • “mpskprofile_mpskgroup_mpskkey”

  • “pkg_authentication_rule”

  • “pkg_central_dnat”

  • “pkg_central_dnat6”

  • “pkg_firewall_acl”

  • “pkg_firewall_acl6”

  • “pkg_firewall_centralsnatmap”

  • “pkg_firewall_consolidated_policy”

  • “pkg_firewall_dospolicy”

  • “pkg_firewall_dospolicy6”

  • “pkg_firewall_explicitproxypolicy”

  • “pkg_firewall_explicitproxypolicy_identitybasedpolicy”

  • “pkg_firewall_hyperscalepolicy”

  • “pkg_firewall_hyperscalepolicy46”

  • “pkg_firewall_hyperscalepolicy6”

  • “pkg_firewall_hyperscalepolicy64”

  • “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_securitypolicy”

  • “pkg_firewall_shapingpolicy”

  • “pkg_user_nacpolicy”

  • “pm_config_pblock_firewall_consolidated_policy”

  • “pm_config_pblock_firewall_policy”

  • “pm_config_pblock_firewall_policy6”

  • “pm_config_pblock_firewall_proxypolicy”

  • “pm_config_pblock_firewall_securitypolicy”

  • “spamfilter_bwl_entries”

  • “spamfilter_bword_entries”

  • “sshfilter_profile_filefilter_entries”

  • “sshfilter_profile_shellcommands”

  • “switchcontroller_dynamicportpolicy_policy”

  • “switchcontroller_managedswitch”

  • “system_externalresource”

  • “system_sdnconnector_compartmentlist”

  • “system_sdnconnector_externalaccountlist”

  • “system_sdnconnector_externalip”

  • “system_sdnconnector_forwardingrule”

  • “system_sdnconnector_gcpprojectlist”

  • “system_sdnconnector_nic”

  • “system_sdnconnector_nic_ip”

  • “system_sdnconnector_ociregionlist”

  • “system_sdnconnector_route”

  • “system_sdnconnector_routetable”

  • “system_sdnconnector_routetable_route”

  • “user_deviceaccesslist_devicelist”

  • “vap_vlanname”

  • “videofilter_profile_filters”

  • “videofilter_profile_fortiguardcategory_filters”

  • “videofilter_youtubechannelfilter_entries”

  • “vpn_ipsec_fec_mappings”

  • “vpn_ssl_settings_authenticationrule”

  • “vpnsslweb_portal_bookmarkgroup”

  • “vpnsslweb_portal_bookmarkgroup_bookmarks”

  • “vpnsslweb_portal_splitdns”

  • “wanprof_system_sdwan_members”

  • “wanprof_system_sdwan_service”

  • “wanprof_system_sdwan_service_sla”

  • “wanprof_system_sdwan_zone”

  • “wanprof_system_virtualwanlink_members”

  • “wanprof_system_virtualwanlink_service”

  • “wanprof_system_virtualwanlink_service_sla”

  • “webfilter_contentheader_entries”

  • “webfilter_profile_filefilter_entries”

  • “webfilter_urlfilter_entries”

  • “wireless_accesscontrollist_layer3ipv4rules”

  • “wireless_accesscontrollist_layer3ipv6rules”

self

字典 / 必需

每个选择器的参数。

target

字符串 / 必需

目标条目的键。

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

workspace_locking_adom

字符串

要为在工作区模式下运行的 FortiManager 锁定的 adom,该值可以是全局的,也可以是包括 root 的其他值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最长时间(以秒为单位)。

默认值: 300

注释

注意

  • 此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成这项工作。

  • 通常,当返回非零 rc 时,运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

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

返回值

常见的返回值记录在此处,以下是此模块独有的字段

描述

meta

字典

请求的结果。

返回:始终

request_url

字符串

请求的完整 URL。

返回:始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回:始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回:始终

response_message

字符串

API 响应的描述性消息。

返回:始终

示例: "OK."

系统信息

字典

目标系统的信息。

返回:始终

返回码

整数

请求的状态。

返回:始终

示例: 0

版本检查警告

列表 / 元素=字符串

如果剧本中使用的参数不被当前 FortiManager 版本支持,则会发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)