fortinet.fortimanager.fmgr_rename module – Rename an object in FortiManager.

Note

This module is part of the fortinet.fortimanager collection (version 2.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_rename.

New in fortinet.fortimanager 2.1.0

Synopsis

  • This module is able to configure a FortiManager device by renaming an object.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0.

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

rename

dictionary / required

Rename An Object.

selector

string / required

Selector of the renamed object.

Choices:

  • "antivirus_mmschecksum"

  • "antivirus_mmschecksum_entries"

  • "antivirus_notification"

  • "antivirus_notification_entries"

  • "antivirus_profile"

  • "apcfgprofile"

  • "apcfgprofile_commandlist"

  • "application_casi_profile"

  • "application_casi_profile_entries"

  • "application_categories"

  • "application_custom"

  • "application_group"

  • "application_internetservice_entry"

  • "application_internetservicecustom"

  • "application_internetservicecustom_disableentry"

  • "application_internetservicecustom_disableentry_iprange"

  • "application_internetservicecustom_entry"

  • "application_internetservicecustom_entry_portrange"

  • "application_list"

  • "application_list_defaultnetworkservices"

  • "application_list_entries"

  • "application_list_entries_parameters"

  • "application_list_entries_parameters_members"

  • "arrpprofile"

  • "authentication_scheme"

  • "bleprofile"

  • "bonjourprofile"

  • "bonjourprofile_policylist"

  • "casb_profile"

  • "casb_profile_saasapplication"

  • "casb_profile_saasapplication_accessrule"

  • "casb_profile_saasapplication_customcontrol"

  • "casb_profile_saasapplication_customcontrol_option"

  • "casb_saasapplication"

  • "casb_useractivity"

  • "casb_useractivity_controloptions"

  • "casb_useractivity_controloptions_operations"

  • "casb_useractivity_match"

  • "casb_useractivity_match_rules"

  • "certificate_template"

  • "cifs_profile"

  • "cloud_orchestaws"

  • "cloud_orchestawsconnector"

  • "cloud_orchestawstemplate_autoscaleexistingvpc"

  • "cloud_orchestawstemplate_autoscalenewvpc"

  • "cloud_orchestawstemplate_autoscaletgwnewvpc"

  • "cloud_orchestration"

  • "devprof_log_syslogd_filter_excludelist"

  • "devprof_log_syslogd_filter_freestyle"

  • "devprof_log_syslogd_setting_customfieldname"

  • "devprof_system_centralmanagement_serverlist"

  • "devprof_system_ntp_ntpserver"

  • "devprof_system_snmp_community"

  • "devprof_system_snmp_community_hosts"

  • "devprof_system_snmp_community_hosts6"

  • "devprof_system_snmp_user"

  • "diameterfilter_profile"

  • "dlp_datatype"

  • "dlp_dictionary"

  • "dlp_dictionary_entries"

  • "dlp_exactdatamatch"

  • "dlp_filepattern"

  • "dlp_fpsensitivity"

  • "dlp_label"

  • "dlp_label_entries"

  • "dlp_profile"

  • "dlp_profile_rule"

  • "dlp_sensitivity"

  • "dlp_sensor"

  • "dlp_sensor_entries"

  • "dlp_sensor_filter"

  • "dnsfilter_domainfilter"

  • "dnsfilter_domainfilter_entries"

  • "dnsfilter_profile"

  • "dnsfilter_profile_dnstranslation"

  • "dnsfilter_profile_ftgddns_filters"

  • "dnsfilter_urlfilter"

  • "dnsfilter_urlfilter_entries"

  • "dvmdb_adom"

  • "dvmdb_device_vdom"

  • "dvmdb_folder"

  • "dvmdb_group"

  • "dvmdb_revision"

  • "dvmdb_script"

  • "dvmdb_script_scriptschedule"

  • "dynamic_address"

  • "dynamic_address_dynamicaddrmapping"

  • "dynamic_certificate_local"

  • "dynamic_certificate_local_dynamicmapping"

  • "dynamic_input_interface"

  • "dynamic_interface"

  • "dynamic_interface_dynamicmapping"

  • "dynamic_interface_platformmapping"

  • "dynamic_ippool"

  • "dynamic_multicast_interface"

  • "dynamic_multicast_interface_dynamicmapping"

  • "dynamic_vip"

  • "dynamic_virtualwanlink_members"

  • "dynamic_virtualwanlink_members_dynamicmapping"

  • "dynamic_virtualwanlink_neighbor"

  • "dynamic_virtualwanlink_server"

  • "dynamic_virtualwanlink_server_dynamicmapping"

  • "dynamic_vpntunnel"

  • "dynamic_vpntunnel_dynamicmapping"

  • "emailfilter_blockallowlist"

  • "emailfilter_blockallowlist_entries"

  • "emailfilter_bwl"

  • "emailfilter_bwl_entries"

  • "emailfilter_bword"

  • "emailfilter_bword_entries"

  • "emailfilter_dnsbl"

  • "emailfilter_dnsbl_entries"

  • "emailfilter_iptrust"

  • "emailfilter_iptrust_entries"

  • "emailfilter_mheader"

  • "emailfilter_mheader_entries"

  • "emailfilter_profile"

  • "endpointcontrol_fctems"

  • "extendercontroller_dataplan"

  • "extendercontroller_extenderprofile"

  • "extendercontroller_extenderprofile_cellular_smsnotification_receiver"

  • "extendercontroller_extenderprofile_lanextension_backhaul"

  • "extendercontroller_simprofile"

  • "extendercontroller_template"

  • "extensioncontroller_dataplan"

  • "extensioncontroller_extenderprofile"

  • "extensioncontroller_extenderprofile_cellular_smsnotification_receiver"

  • "extensioncontroller_extenderprofile_lanextension_backhaul"

  • "extensioncontroller_extendervap"

  • "filefilter_profile"

  • "filefilter_profile_rules"

  • "firewall_accessproxy"

  • "firewall_accessproxy6"

  • "firewall_accessproxy6_apigateway"

  • "firewall_accessproxy6_apigateway6"

  • "firewall_accessproxy6_apigateway6_realservers"

  • "firewall_accessproxy6_apigateway_realservers"

  • "firewall_accessproxy_apigateway"

  • "firewall_accessproxy_apigateway6"

  • "firewall_accessproxy_apigateway6_realservers"

  • "firewall_accessproxy_apigateway_realservers"

  • "firewall_accessproxy_realservers"

  • "firewall_accessproxy_serverpubkeyauthsettings_certextension"

  • "firewall_accessproxysshclientcert"

  • "firewall_accessproxysshclientcert_certextension"

  • "firewall_accessproxyvirtualhost"

  • "firewall_address"

  • "firewall_address6"

  • "firewall_address6_dynamicmapping"

  • "firewall_address6_dynamicmapping_subnetsegment"

  • "firewall_address6_list"

  • "firewall_address6_subnetsegment"

  • "firewall_address6_tagging"

  • "firewall_address6template"

  • "firewall_address6template_subnetsegment"

  • "firewall_address6template_subnetsegment_values"

  • "firewall_address_dynamicmapping"

  • "firewall_address_list"

  • "firewall_address_tagging"

  • "firewall_addrgrp"

  • "firewall_addrgrp6"

  • "firewall_addrgrp6_dynamicmapping"

  • "firewall_addrgrp6_tagging"

  • "firewall_addrgrp_dynamicmapping"

  • "firewall_addrgrp_tagging"

  • "firewall_carrierendpointbwl"

  • "firewall_carrierendpointbwl_entries"

  • "firewall_casbprofile"

  • "firewall_casbprofile_saasapplication"

  • "firewall_casbprofile_saasapplication_accessrule"

  • "firewall_casbprofile_saasapplication_customcontrol"

  • "firewall_casbprofile_saasapplication_customcontrol_option"

  • "firewall_decryptedtrafficmirror"

  • "firewall_explicitproxyaddress"

  • "firewall_explicitproxyaddress_headergroup"

  • "firewall_explicitproxyaddrgrp"

  • "firewall_gtp"

  • "firewall_gtp_apn"

  • "firewall_gtp_ieremovepolicy"

  • "firewall_gtp_imsi"

  • "firewall_gtp_ippolicy"

  • "firewall_gtp_noippolicy"

  • "firewall_gtp_perapnshaper"

  • "firewall_gtp_policy"

  • "firewall_gtp_policyv2"

  • "firewall_identitybasedroute"

  • "firewall_identitybasedroute_rule"

  • "firewall_internetservice_entry"

  • "firewall_internetserviceaddition"

  • "firewall_internetserviceaddition_entry"

  • "firewall_internetserviceaddition_entry_portrange"

  • "firewall_internetservicecustom"

  • "firewall_internetservicecustom_disableentry"

  • "firewall_internetservicecustom_disableentry_iprange"

  • "firewall_internetservicecustom_entry"

  • "firewall_internetservicecustom_entry_portrange"

  • "firewall_internetservicecustomgroup"

  • "firewall_internetserviceextension"

  • "firewall_internetserviceextension_disableentry"

  • "firewall_internetserviceextension_disableentry_ip6range"

  • "firewall_internetserviceextension_disableentry_iprange"

  • "firewall_internetserviceextension_disableentry_portrange"

  • "firewall_internetserviceextension_entry"

  • "firewall_internetserviceextension_entry_portrange"

  • "firewall_internetservicegroup"

  • "firewall_internetservicename"

  • "firewall_ippool"

  • "firewall_ippool6"

  • "firewall_ippool6_dynamicmapping"

  • "firewall_ippool_dynamicmapping"

  • "firewall_ippoolgrp"

  • "firewall_ldbmonitor"

  • "firewall_mmsprofile"

  • "firewall_mmsprofile_notifmsisdn"

  • "firewall_multicastaddress"

  • "firewall_multicastaddress6"

  • "firewall_multicastaddress6_tagging"

  • "firewall_multicastaddress_tagging"

  • "firewall_networkservicedynamic"

  • "firewall_profilegroup"

  • "firewall_profileprotocoloptions"

  • "firewall_proxyaddress"

  • "firewall_proxyaddress_headergroup"

  • "firewall_proxyaddress_tagging"

  • "firewall_proxyaddrgrp"

  • "firewall_proxyaddrgrp_tagging"

  • "firewall_schedule_group"

  • "firewall_schedule_onetime"

  • "firewall_schedule_recurring"

  • "firewall_service_category"

  • "firewall_service_custom"

  • "firewall_service_group"

  • "firewall_shaper_peripshaper"

  • "firewall_shaper_trafficshaper"

  • "firewall_shapingprofile"

  • "firewall_shapingprofile_shapingentries"

  • "firewall_ssh_localca"

  • "firewall_sslsshprofile"

  • "firewall_sslsshprofile_echoutersni"

  • "firewall_sslsshprofile_sslexempt"

  • "firewall_sslsshprofile_sslserver"

  • "firewall_vip"

  • "firewall_vip46"

  • "firewall_vip46_dynamicmapping"

  • "firewall_vip46_realservers"

  • "firewall_vip6"

  • "firewall_vip64"

  • "firewall_vip64_dynamicmapping"

  • "firewall_vip64_realservers"

  • "firewall_vip6_dynamicmapping"

  • "firewall_vip6_dynamicmapping_realservers"

  • "firewall_vip6_realservers"

  • "firewall_vip6_sslciphersuites"

  • "firewall_vip6_sslserverciphersuites"

  • "firewall_vip_dynamicmapping"

  • "firewall_vip_dynamicmapping_realservers"

  • "firewall_vip_dynamicmapping_sslciphersuites"

  • "firewall_vip_realservers"

  • "firewall_vip_sslciphersuites"

  • "firewall_vip_sslserverciphersuites"

  • "firewall_vipgrp"

  • "firewall_vipgrp46"

  • "firewall_vipgrp6"

  • "firewall_vipgrp64"

  • "firewall_vipgrp_dynamicmapping"

  • "firewall_wildcardfqdn_custom"

  • "firewall_wildcardfqdn_group"

  • "fmg_device_blueprint"

  • "fmg_fabric_authorization_template"

  • "fmg_variable"

  • "fmupdate_fdssetting_pushoverridetoclient_announceip"

  • "fmupdate_fdssetting_serveroverride_servlist"

  • "fmupdate_serveraccesspriorities_privateserver"

  • "fmupdate_webspam_fgdsetting_serveroverride_servlist"

  • "fsp_vlan"

  • "fsp_vlan_dhcpserver_excluderange"

  • "fsp_vlan_dhcpserver_iprange"

  • "fsp_vlan_dhcpserver_options"

  • "fsp_vlan_dhcpserver_reservedaddress"

  • "fsp_vlan_dynamicmapping_dhcpserver_excluderange"

  • "fsp_vlan_dynamicmapping_dhcpserver_iprange"

  • "fsp_vlan_dynamicmapping_dhcpserver_options"

  • "fsp_vlan_dynamicmapping_dhcpserver_reservedaddress"

  • "fsp_vlan_dynamicmapping_interface_secondaryip"

  • "fsp_vlan_dynamicmapping_interface_vrrp_proxyarp"

  • "fsp_vlan_interface_secondaryip"

  • "fsp_vlan_interface_vrrp"

  • "fsp_vlan_interface_vrrp_proxyarp"

  • "gtp_apn"

  • "gtp_apngrp"

  • "gtp_ieallowlist"

  • "gtp_ieallowlist_entries"

  • "gtp_iewhitelist"

  • "gtp_iewhitelist_entries"

  • "gtp_messagefilterv0v1"

  • "gtp_messagefilterv2"

  • "gtp_rattimeoutprofile"

  • "gtp_tunnellimit"

  • "hotspot20_anqp3gppcellular"

  • "hotspot20_anqp3gppcellular_mccmnclist"

  • "hotspot20_anqpipaddresstype"

  • "hotspot20_anqpnairealm"

  • "hotspot20_anqpnairealm_nailist"

  • "hotspot20_anqpnairealm_nailist_eapmethod"

  • "hotspot20_anqpnairealm_nailist_eapmethod_authparam"

  • "hotspot20_anqpnetworkauthtype"

  • "hotspot20_anqproamingconsortium"

  • "hotspot20_anqproamingconsortium_oilist"

  • "hotspot20_anqpvenuename"

  • "hotspot20_anqpvenuename_valuelist"

  • "hotspot20_anqpvenueurl"

  • "hotspot20_h2qpadviceofcharge"

  • "hotspot20_h2qpadviceofcharge_aoclist"

  • "hotspot20_h2qpadviceofcharge_aoclist_planinfo"

  • "hotspot20_h2qpconncapability"

  • "hotspot20_h2qpoperatorname"

  • "hotspot20_h2qpoperatorname_valuelist"

  • "hotspot20_h2qposuprovider"

  • "hotspot20_h2qposuprovider_friendlyname"

  • "hotspot20_h2qposuprovider_servicedescription"

  • "hotspot20_h2qposuprovidernai"

  • "hotspot20_h2qposuprovidernai_nailist"

  • "hotspot20_h2qptermsandconditions"

  • "hotspot20_h2qpwanmetric"

  • "hotspot20_hsprofile"

  • "hotspot20_icon"

  • "hotspot20_icon_iconlist"

  • "hotspot20_qosmap"

  • "hotspot20_qosmap_dscpexcept"

  • "hotspot20_qosmap_dscprange"

  • "icap_profile"

  • "icap_profile_icapheaders"

  • "icap_profile_respmodforwardrules"

  • "icap_profile_respmodforwardrules_headergroup"

  • "icap_server"

  • "icap_servergroup"

  • "icap_servergroup_serverlist"

  • "ips_baseline_sensor"

  • "ips_baseline_sensor_entries"

  • "ips_baseline_sensor_entries_exemptip"

  • "ips_baseline_sensor_filter"

  • "ips_baseline_sensor_override_exemptip"

  • "ips_custom"

  • "ips_sensor"

  • "ips_sensor_entries"

  • "ips_sensor_entries_exemptip"

  • "log_customfield"

  • "log_npuserver_serverinfo"

  • "mpskprofile"

  • "mpskprofile_mpskgroup"

  • "mpskprofile_mpskgroup_mpskkey"

  • "nacprofile"

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

  • "pkg_firewall_dospolicy_anomaly"

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

  • "pkg_firewall_policy_vpnsrcnode"

  • "pkg_firewall_proxypolicy"

  • "pkg_firewall_securitypolicy"

  • "pkg_firewall_shapingpolicy"

  • "pkg_footer_policy"

  • "pkg_footer_policy6"

  • "pkg_footer_shapingpolicy"

  • "pkg_header_policy"

  • "pkg_header_policy6"

  • "pkg_header_shapingpolicy"

  • "pkg_user_nacpolicy"

  • "pkg_videofilter_youtubekey"

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

  • "pm_devprof_pkg"

  • "pm_pblock_obj"

  • "pm_pkg"

  • "pm_wanprof_pkg"

  • "qosprofile"

  • "region"

  • "router_accesslist"

  • "router_accesslist6"

  • "router_accesslist6_rule"

  • "router_accesslist_rule"

  • "router_aspathlist"

  • "router_aspathlist_rule"

  • "router_communitylist"

  • "router_communitylist_rule"

  • "router_prefixlist"

  • "router_prefixlist6"

  • "router_prefixlist6_rule"

  • "router_prefixlist_rule"

  • "router_routemap"

  • "router_routemap_rule"

  • "sctpfilter_profile"

  • "sctpfilter_profile_ppidfilters"

  • "spamfilter_bwl"

  • "spamfilter_bwl_entries"

  • "spamfilter_bword"

  • "spamfilter_bword_entries"

  • "spamfilter_dnsbl"

  • "spamfilter_dnsbl_entries"

  • "spamfilter_iptrust"

  • "spamfilter_iptrust_entries"

  • "spamfilter_mheader"

  • "spamfilter_mheader_entries"

  • "spamfilter_profile"

  • "sshfilter_profile"

  • "sshfilter_profile_shellcommands"

  • "switchcontroller_acl_group"

  • "switchcontroller_acl_ingress"

  • "switchcontroller_dsl_policy"

  • "switchcontroller_dynamicportpolicy"

  • "switchcontroller_dynamicportpolicy_policy"

  • "switchcontroller_fortilinksettings"

  • "switchcontroller_lldpprofile"

  • "switchcontroller_lldpprofile_customtlvs"

  • "switchcontroller_lldpprofile_medlocationservice"

  • "switchcontroller_lldpprofile_mednetworkpolicy"

  • "switchcontroller_macpolicy"

  • "switchcontroller_managedswitch"

  • "switchcontroller_managedswitch_dhcpsnoopingstaticclient"

  • "switchcontroller_managedswitch_ports"

  • "switchcontroller_managedswitch_remotelog"

  • "switchcontroller_managedswitch_snmpcommunity"

  • "switchcontroller_managedswitch_snmpcommunity_hosts"

  • "switchcontroller_managedswitch_snmpuser"

  • "switchcontroller_ptp_profile"

  • "switchcontroller_qos_dot1pmap"

  • "switchcontroller_qos_ipdscpmap"

  • "switchcontroller_qos_ipdscpmap_map"

  • "switchcontroller_qos_qospolicy"

  • "switchcontroller_qos_queuepolicy"

  • "switchcontroller_qos_queuepolicy_cosqueue"

  • "switchcontroller_securitypolicy_8021x"

  • "switchcontroller_securitypolicy_captiveportal"

  • "switchcontroller_switchinterfacetag"

  • "switchcontroller_trafficpolicy"

  • "switchcontroller_vlanpolicy"

  • "system_admin_group"

  • "system_admin_group_member"

  • "system_admin_ldap"

  • "system_admin_ldap_adom"

  • "system_admin_profile"

  • "system_admin_profile_datamaskcustomfields"

  • "system_admin_radius"

  • "system_admin_tacacs"

  • "system_admin_user"

  • "system_admin_user_adom"

  • "system_admin_user_adomexclude"

  • "system_admin_user_appfilter"

  • "system_admin_user_dashboard"

  • "system_admin_user_dashboardtabs"

  • "system_admin_user_ipsfilter"

  • "system_admin_user_metadata"

  • "system_admin_user_policypackage"

  • "system_admin_user_restrictdevvdom"

  • "system_admin_user_webfilter"

  • "system_alertevent"

  • "system_certificate_ca"

  • "system_certificate_crl"

  • "system_certificate_local"

  • "system_certificate_remote"

  • "system_certificate_ssh"

  • "system_csf_trustedlist"

  • "system_customlanguage"

  • "system_dhcp_server"

  • "system_dhcp_server_excluderange"

  • "system_dhcp_server_iprange"

  • "system_dhcp_server_options"

  • "system_dhcp_server_reservedaddress"

  • "system_externalresource"

  • "system_fmgcluster_peer"

  • "system_geoipcountry"

  • "system_geoipoverride"

  • "system_geoipoverride_ip6range"

  • "system_geoipoverride_iprange"

  • "system_ha_monitoredips"

  • "system_ha_peer"

  • "system_interface"

  • "system_interface_member"

  • "system_localinpolicy"

  • "system_localinpolicy6"

  • "system_log_devicedisable"

  • "system_log_deviceselector"

  • "system_log_maildomain"

  • "system_log_ratelimit_device"

  • "system_log_ratelimit_ratelimits"

  • "system_logfetch_clientprofile"

  • "system_logfetch_clientprofile_devicefilter"

  • "system_logfetch_clientprofile_logfilter"

  • "system_mail"

  • "system_meta"

  • "system_meta_sysmetafields"

  • "system_metadata_admins"

  • "system_npu_dswqueuedtsprofile"

  • "system_npu_npqueues_ethernettype"

  • "system_npu_npqueues_ipprotocol"

  • "system_npu_npqueues_ipservice"

  • "system_npu_npqueues_profile"

  • "system_npu_npqueues_scheduler"

  • "system_npu_nputcam"

  • "system_npu_tcptimeoutprofile"

  • "system_npu_udptimeoutprofile"

  • "system_ntp_ntpserver"

  • "system_objecttag"

  • "system_objecttagging"

  • "system_replacemsggroup"

  • "system_replacemsggroup_admin"

  • "system_replacemsggroup_alertmail"

  • "system_replacemsggroup_auth"

  • "system_replacemsggroup_custommessage"

  • "system_replacemsggroup_devicedetectionportal"

  • "system_replacemsggroup_ec"

  • "system_replacemsggroup_fortiguardwf"

  • "system_replacemsggroup_ftp"

  • "system_replacemsggroup_http"

  • "system_replacemsggroup_icap"

  • "system_replacemsggroup_mail"

  • "system_replacemsggroup_mm1"

  • "system_replacemsggroup_mm3"

  • "system_replacemsggroup_mm4"

  • "system_replacemsggroup_mm7"

  • "system_replacemsggroup_mms"

  • "system_replacemsggroup_nacquar"

  • "system_replacemsggroup_nntp"

  • "system_replacemsggroup_spam"

  • "system_replacemsggroup_sslvpn"

  • "system_replacemsggroup_trafficquota"

  • "system_replacemsggroup_utm"

  • "system_replacemsggroup_webproxy"

  • "system_replacemsgimage"

  • "system_report_group"

  • "system_report_group_chartalternative"

  • "system_report_group_groupby"

  • "system_route"

  • "system_route6"

  • "system_sdnconnector"

  • "system_sdnconnector_externalip"

  • "system_sdnconnector_gcpprojectlist"

  • "system_sdnconnector_nic"

  • "system_sdnconnector_nic_ip"

  • "system_sdnconnector_route"

  • "system_sdnconnector_routetable"

  • "system_sdnconnector_routetable_route"

  • "system_sdnproxy"

  • "system_smsserver"

  • "system_sniffer"

  • "system_snmp_community"

  • "system_snmp_community_hosts"

  • "system_snmp_community_hosts6"

  • "system_snmp_user"

  • "system_socfabric_trustedlist"

  • "system_sql_customindex"

  • "system_sql_customskipidx"

  • "system_syslog"

  • "system_virtualwirepair"

  • "system_workflow_approvalmatrix"

  • "system_workflow_approvalmatrix_approver"

  • "telemetrycontroller_agentprofile"

  • "telemetrycontroller_profile"

  • "telemetrycontroller_profile_application"

  • "template"

  • "templategroup"

  • "ums_setting"

  • "user_adgrp"

  • "user_certificate"

  • "user_clearpass"

  • "user_connector"

  • "user_device"

  • "user_device_dynamicmapping"

  • "user_device_tagging"

  • "user_deviceaccesslist"

  • "user_deviceaccesslist_devicelist"

  • "user_devicecategory"

  • "user_devicegroup"

  • "user_devicegroup_dynamicmapping"

  • "user_devicegroup_tagging"

  • "user_domaincontroller"

  • "user_domaincontroller_extraserver"

  • "user_exchange"

  • "user_externalidentityprovider"

  • "user_flexvm"

  • "user_fortitoken"

  • "user_fsso"

  • "user_fsso_dynamicmapping"

  • "user_fssopolling"

  • "user_fssopolling_adgrp"

  • "user_group"

  • "user_group_dynamicmapping"

  • "user_group_dynamicmapping_guest"

  • "user_group_dynamicmapping_match"

  • "user_group_guest"

  • "user_group_match"

  • "user_json"

  • "user_krbkeytab"

  • "user_ldap"

  • "user_ldap_dynamicmapping"

  • "user_local"

  • "user_nsx"

  • "user_nsx_service"

  • "user_passwordpolicy"

  • "user_peer"

  • "user_peergrp"

  • "user_pop3"

  • "user_pxgrid"

  • "user_radius"

  • "user_radius_accountingserver"

  • "user_radius_dynamicmapping"

  • "user_radius_dynamicmapping_accountingserver"

  • "user_saml"

  • "user_scim"

  • "user_securityexemptlist"

  • "user_securityexemptlist_rule"

  • "user_tacacs"

  • "user_tacacs_dynamicmapping"

  • "user_vcenter"

  • "user_vcenter_rule"

  • "utmprofile"

  • "vap"

  • "vap_dynamicmapping"

  • "vap_macfilterlist"

  • "vap_mpskkey"

  • "vap_vlanname"

  • "vap_vlanpool"

  • "vapgroup"

  • "videofilter_keyword"

  • "videofilter_keyword_word"

  • "videofilter_profile"

  • "videofilter_profile_filters"

  • "videofilter_profile_fortiguardcategory_filters"

  • "videofilter_youtubechannelfilter"

  • "videofilter_youtubechannelfilter_entries"

  • "videofilter_youtubekey"

  • "virtualpatch_profile"

  • "virtualpatch_profile_exemption"

  • "voip_profile"

  • "vpn_certificate_ca"

  • "vpn_certificate_ocspserver"

  • "vpn_certificate_remote"

  • "vpn_ipsec_fec"

  • "vpn_ssl_settings_authenticationrule"

  • "vpnmgr_node"

  • "vpnmgr_node_iprange"

  • "vpnmgr_node_ipv4excluderange"

  • "vpnmgr_node_protectedsubnet"

  • "vpnmgr_node_summaryaddr"

  • "vpnmgr_vpntable"

  • "vpnsslweb_hostchecksoftware"

  • "vpnsslweb_hostchecksoftware_checkitemlist"

  • "vpnsslweb_portal"

  • "vpnsslweb_portal_bookmarkgroup"

  • "vpnsslweb_portal_bookmarkgroup_bookmarks"

  • "vpnsslweb_portal_bookmarkgroup_bookmarks_formdata"

  • "vpnsslweb_portal_landingpage_formdata"

  • "vpnsslweb_portal_macaddrcheckrule"

  • "vpnsslweb_portal_splitdns"

  • "vpnsslweb_virtualdesktopapplist"

  • "vpnsslweb_virtualdesktopapplist_apps"

  • "waf_mainclass"

  • "waf_profile"

  • "waf_profile_constraint_exception"

  • "waf_profile_method_methodpolicy"

  • "waf_profile_signature_customsignature"

  • "waf_profile_urlaccess"

  • "waf_profile_urlaccess_accesspattern"

  • "waf_signature"

  • "waf_subclass"

  • "wagprofile"

  • "wanopt_authgroup"

  • "wanopt_peer"

  • "wanopt_profile"

  • "wanprof_system_sdwan_duplication"

  • "wanprof_system_sdwan_healthcheck"

  • "wanprof_system_sdwan_healthcheck_sla"

  • "wanprof_system_sdwan_members"

  • "wanprof_system_sdwan_service"

  • "wanprof_system_sdwan_service_sla"

  • "wanprof_system_sdwan_zone"

  • "wanprof_system_virtualwanlink_healthcheck"

  • "wanprof_system_virtualwanlink_healthcheck_sla"

  • "wanprof_system_virtualwanlink_members"

  • "wanprof_system_virtualwanlink_service"

  • "wanprof_system_virtualwanlink_service_sla"

  • "webfilter_categories"

  • "webfilter_content"

  • "webfilter_content_entries"

  • "webfilter_contentheader"

  • "webfilter_ftgdlocalcat"

  • "webfilter_ftgdlocalrating"

  • "webfilter_profile"

  • "webfilter_profile_antiphish_inspectionentries"

  • "webfilter_profile_ftgdwf_filters"

  • "webfilter_profile_ftgdwf_quota"

  • "webfilter_profile_youtubechannelfilter"

  • "webfilter_urlfilter"

  • "webfilter_urlfilter_entries"

  • "webproxy_forwardserver"

  • "webproxy_forwardservergroup"

  • "webproxy_forwardservergroup_serverlist"

  • "webproxy_profile"

  • "webproxy_profile_headers"

  • "webproxy_wisp"

  • "widsprofile"

  • "wireless_accesscontrollist"

  • "wireless_address"

  • "wireless_addrgrp"

  • "wireless_ssidpolicy"

  • "wireless_syslogprofile"

  • "wtpprofile"

  • "wtpprofile_denymaclist"

  • "wtpprofile_splittunnelingacl"

self

dictionary / required

The parameter for each selector.

target

dictionary / required

Attribute to override for target object.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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.

  • 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

- name: Rename an object
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Rename a vip object using fmgr_rename module.
      fortinet.fortimanager.fmgr_rename:
        rename:
          selector: "firewall_vip"
          self:
            adom: "root"
            vip: "ansible-test-vip_first"
          target:
            name: "ansible-test-vip_fourth"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)