:source: faz_rename.py
:orphan:
.. _faz_rename:
faz_rename -- Rename An Object.
+++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiAnalyzer v6.x and v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16.0
Parameters
----------
.. raw:: html
access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
enable_log Enable/Disable logging for task type: bool default: False
forticloud_access_token Access token of forticloud analyzer API users. type: str
log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: True
rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
rc_failed The rc codes list with which the conditions to fail will be overriden type: list
rename Rename An Object. type: dict
target Attribute to override for target object. type: dictrequired: true
params for cli_fmupdate_fdssetting_pushoverridetoclient_announceip:
selector selector of the renamed object type: strchoices:
cli_fmupdate_fdssetting_pushoverridetoclient_announceip - available versions:
>= 6.2.1
cli_fmupdate_fdssetting_serveroverride_servlist - available versions:
>= 6.2.1
cli_fmupdate_serveraccesspriorities_privateserver - available versions:
>= 6.2.1
cli_fmupdate_webspam_fgdsetting_serveroverride_servlist - available versions:
6.2.1-7.6.2
cli_system_admin_group - available versions:
>= 6.2.1
cli_system_admin_group_member - available versions:
>= 6.2.1
cli_system_admin_ldap - available versions:
>= 6.2.1
cli_system_admin_ldap_adom - available versions:
>= 6.2.1
cli_system_admin_profile - available versions:
>= 6.2.1
cli_system_admin_profile_datamaskcustomfields - available versions:
>= 6.2.1
cli_system_admin_profile_writepasswdprofiles - available versions:
>= 7.4.2
cli_system_admin_profile_writepasswduserlist - available versions:
>= 7.4.2
cli_system_admin_radius - available versions:
>= 6.2.1
cli_system_admin_tacacs - available versions:
>= 6.2.1
cli_system_admin_user - available versions:
>= 6.2.1
cli_system_admin_user_adom - available versions:
>= 6.2.1
cli_system_admin_user_adomexclude - available versions:
6.2.1-7.0.2
cli_system_admin_user_dashboard - available versions:
>= 6.2.1
cli_system_admin_user_dashboardtabs - available versions:
>= 6.2.1
cli_system_admin_user_metadata - available versions:
>= 6.2.1
cli_system_admin_user_policyblock - available versions:
>= 7.6.0
cli_system_admin_user_policypackage - available versions:
>= 6.2.1
cli_system_admin_user_restrictdevvdom - available versions:
6.2.1-6.2.3
cli_system_alertevent - available versions:
>= 6.2.1
cli_system_certificate_ca - available versions:
>= 6.2.1
cli_system_certificate_crl - available versions:
>= 6.2.1
cli_system_certificate_local - available versions:
>= 6.2.1
cli_system_certificate_remote - available versions:
>= 6.2.1
cli_system_certificate_ssh - available versions:
>= 6.2.1
cli_system_csf_fabricconnector - available versions:
>= 7.4.1
cli_system_csf_trustedlist - available versions:
>= 7.4.1
cli_system_ha_peer - available versions:
>= 6.2.1
cli_system_ha_privatepeer - available versions:
>= 6.2.1
cli_system_ha_vip - available versions:
>= 7.0.5
cli_system_interface - available versions:
>= 6.2.1
cli_system_interface_member - available versions:
>= 6.4.9
cli_system_localinpolicy - available versions:
>= 7.2.0
cli_system_localinpolicy6 - available versions:
>= 7.2.0
cli_system_log_devicedisable - available versions:
6.4.4-7.4.6, 7.6.0-7.6.2
cli_system_log_deviceselector - available versions:
7.4.7-7.4.8, >= 7.6.3
cli_system_log_maildomain - available versions:
>= 6.2.1
cli_system_log_ratelimit_device - available versions:
6.4.8-7.0.2
cli_system_log_ratelimit_ratelimits - available versions:
>= 7.0.3
cli_system_logfetch_clientprofile - available versions:
>= 6.2.1
cli_system_logfetch_clientprofile_devicefilter - available versions:
>= 6.2.1
cli_system_logfetch_clientprofile_logfilter - available versions:
>= 6.2.1
cli_system_logforward - available versions:
>= 6.2.1
cli_system_logforward_devicefilter - available versions:
>= 6.2.1
cli_system_logforward_logfieldexclusion - available versions:
>= 6.2.1
cli_system_logforward_logfilter - available versions:
>= 6.2.1
cli_system_logforward_logmaskingcustom - available versions:
>= 7.0.0
cli_system_mail - available versions:
>= 6.2.1
cli_system_metadata_admins - available versions:
>= 6.2.1
cli_system_ntp_ntpserver - available versions:
>= 6.2.1
cli_system_report_group - available versions:
>= 6.2.1
cli_system_report_group_chartalternative - available versions:
>= 6.2.1
cli_system_report_group_groupby - available versions:
>= 6.2.1
cli_system_route - available versions:
>= 6.2.1
cli_system_route6 - available versions:
>= 6.2.1
cli_system_saml_fabricidp - available versions:
6.2.1-6.2.1, >= 6.4.1
cli_system_saml_serviceproviders - available versions:
>= 6.2.1
cli_system_sniffer - available versions:
>= 6.2.1
cli_system_snmp_community - available versions:
>= 6.2.1
cli_system_snmp_community_hosts - available versions:
>= 6.2.1
cli_system_snmp_community_hosts6 - available versions:
>= 6.2.1
cli_system_snmp_user - available versions:
>= 6.2.1
cli_system_socfabric_trustedlist - available versions:
>= 7.4.0
cli_system_sql_customindex - available versions:
>= 6.2.1
cli_system_sql_customskipidx - available versions:
6.2.1-6.2.1, >= 6.2.3
cli_system_sql_tsindexfield - available versions:
>= 6.2.1
cli_system_sslciphersuites - available versions:
6.4.8-6.4.15, >= 7.0.2
cli_system_syslog - available versions:
>= 6.2.1
cli_system_workflow_approvalmatrix - available versions:
6.2.1-6.2.9, 6.4.1-6.4.7, 7.0.0-7.0.2, >= 7.6.0
cli_system_workflow_approvalmatrix_approver - available versions:
6.2.1-6.2.9, 6.4.1-6.4.7, 7.0.0-7.0.2, >= 7.6.0
dvmdb_adom - available versions:
>= 6.2.1
dvmdb_device_vdom - available versions:
>= 6.2.1
dvmdb_folder - available versions:
>= 6.4.2
dvmdb_group - available versions:
>= 6.2.1
eventmgmt_config_basichandler - available versions:
>= 7.2.2
eventmgmt_config_correlationhandler - available versions:
>= 7.2.2
eventmgmt_config_dataselector - available versions:
>= 7.2.2
eventmgmt_config_notificationprofile - available versions:
>= 7.2.2
eventmgmt_config_trigger - available versions:
6.2.1-7.2.1
eventmgmt_config_trigger_device - available versions:
6.2.1-7.2.1
eventmgmt_config_trigger_filter - available versions:
6.2.1-7.2.1
eventmgmt_config_trigger_filter_rule - available versions:
6.2.1-7.2.1
report_config_chart - available versions:
>= 6.2.1
report_config_chart_drilldowntable - available versions:
>= 6.2.1
report_config_chart_tablecolumns - available versions:
>= 6.2.1
report_config_chart_variabletemplate - available versions:
>= 6.2.1
report_config_dataset - available versions:
>= 6.2.1
report_config_dataset_variable - available versions:
>= 6.2.1
report_config_layout - available versions:
>= 6.2.1
report_config_layout_component - available versions:
>= 6.2.1
report_config_layout_component_variable - available versions:
>= 6.2.1
report_config_layout_footer - available versions:
>= 6.2.1
report_config_layout_header - available versions:
>= 6.2.1
report_config_layoutfolder - available versions:
>= 6.2.1
report_config_macro - available versions:
>= 6.2.1
report_config_output - available versions:
>= 6.2.1
report_config_output_emailrecipients - available versions:
>= 6.2.1
report_config_schedule - available versions:
>= 6.2.1
report_config_schedule_addressfilter - available versions:
>= 6.4.3
report_config_schedule_devices - available versions:
>= 6.2.1
report_config_schedule_filter - available versions:
>= 6.2.1
report_config_schedule_reportlayout - available versions:
>= 6.2.1
self The parameter for each selector type: dictchoices:
params for cli_fmupdate_fdssetting_pushoverridetoclient_announceip:
announce-ip
params for cli_fmupdate_fdssetting_serveroverride_servlist:
servlist
params for cli_fmupdate_serveraccesspriorities_privateserver:
private-server
params for cli_fmupdate_webspam_fgdsetting_serveroverride_servlist:
servlist
params for cli_system_admin_group:
group
params for cli_system_admin_group_member:
group
member
params for cli_system_admin_ldap:
ldap
params for cli_system_admin_ldap_adom:
adom
ldap
params for cli_system_admin_profile:
profile
params for cli_system_admin_profile_datamaskcustomfields:
datamask-custom-fields
profile
params for cli_system_admin_profile_writepasswdprofiles:
profile
write-passwd-profiles
params for cli_system_admin_profile_writepasswduserlist:
profile
write-passwd-user-list
params for cli_system_admin_radius:
radius
params for cli_system_admin_tacacs:
tacacs
params for cli_system_admin_user:
user
params for cli_system_admin_user_adom:
adom
user
params for cli_system_admin_user_adomexclude:
adom-exclude
user
params for cli_system_admin_user_dashboard:
dashboard
user
params for cli_system_admin_user_dashboardtabs:
dashboard-tabs
user
params for cli_system_admin_user_metadata:
meta-data
user
params for cli_system_admin_user_policyblock:
policy-block
user
params for cli_system_admin_user_policypackage:
policy-package
user
params for cli_system_admin_user_restrictdevvdom:
restrict-dev-vdom
user
params for cli_system_alertevent:
alert-event
params for cli_system_certificate_ca:
ca
params for cli_system_certificate_crl:
crl
params for cli_system_certificate_local:
local
params for cli_system_certificate_remote:
remote
params for cli_system_certificate_ssh:
ssh
params for cli_system_csf_fabricconnector:
fabric-connector
params for cli_system_csf_trustedlist:
trusted-list
params for cli_system_ha_peer:
peer
params for cli_system_ha_privatepeer:
private-peer
params for cli_system_ha_vip:
vip
params for cli_system_interface:
interface
params for cli_system_interface_member:
interface
member
params for cli_system_localinpolicy:
local-in-policy
params for cli_system_localinpolicy6:
local-in-policy6
params for cli_system_log_devicedisable:
device-disable
params for cli_system_log_deviceselector:
device-selector
params for cli_system_log_maildomain:
mail-domain
params for cli_system_log_ratelimit_device:
device
params for cli_system_log_ratelimit_ratelimits:
ratelimits
params for cli_system_logfetch_clientprofile:
client-profile
params for cli_system_logfetch_clientprofile_devicefilter:
client-profile
device-filter
params for cli_system_logfetch_clientprofile_logfilter:
client-profile
log-filter
params for cli_system_logforward:
log-forward
params for cli_system_logforward_devicefilter:
device-filter
log-forward
params for cli_system_logforward_logfieldexclusion:
log-field-exclusion
log-forward
params for cli_system_logforward_logfilter:
log-filter
log-forward
params for cli_system_logforward_logmaskingcustom:
log-forward
log-masking-custom
params for cli_system_mail:
mail
params for cli_system_metadata_admins:
admins
params for cli_system_ntp_ntpserver:
ntpserver
params for cli_system_report_group:
group
params for cli_system_report_group_chartalternative:
chart-alternative
group
params for cli_system_report_group_groupby:
group
group-by
params for cli_system_route:
route
params for cli_system_route6:
route6
params for cli_system_saml_fabricidp:
fabric-idp
params for cli_system_saml_serviceproviders:
service-providers
params for cli_system_sniffer:
sniffer
params for cli_system_snmp_community:
community
params for cli_system_snmp_community_hosts:
community
hosts
params for cli_system_snmp_community_hosts6:
community
hosts6
params for cli_system_snmp_user:
user
params for cli_system_socfabric_trustedlist:
trusted-list
params for cli_system_sql_customindex:
custom-index
params for cli_system_sql_customskipidx:
custom-skipidx
params for cli_system_sql_tsindexfield:
ts-index-field
params for cli_system_sslciphersuites:
ssl-cipher-suites
params for cli_system_syslog:
syslog
params for cli_system_workflow_approvalmatrix:
approval-matrix
params for cli_system_workflow_approvalmatrix_approver:
approval-matrix
approver
params for dvmdb_adom:
adom
params for dvmdb_device_vdom:
adom
device
vdom
params for dvmdb_folder:
adom
folder
params for dvmdb_group:
adom
group
params for eventmgmt_config_basichandler:
adom
basic-handler
params for eventmgmt_config_correlationhandler:
adom
correlation-handler
params for eventmgmt_config_dataselector:
adom
data-selector
params for eventmgmt_config_notificationprofile:
adom
notification-profile
params for eventmgmt_config_trigger:
adom
trigger
params for eventmgmt_config_trigger_device:
adom
device
trigger_id
params for eventmgmt_config_trigger_filter:
adom
filter
trigger_id
params for eventmgmt_config_trigger_filter_rule:
adom
filter_id
rule
trigger_id
params for report_config_chart:
adom
chart
params for report_config_chart_drilldowntable:
adom
chart_name
drill-down-table
params for report_config_chart_tablecolumns:
adom
chart_name
table-columns
params for report_config_chart_variabletemplate:
adom
chart_name
variable-template
params for report_config_dataset:
adom
dataset
params for report_config_dataset_variable:
adom
dataset_name
variable
params for report_config_layout:
adom
layout
params for report_config_layout_component:
adom
component
layout-id
params for report_config_layout_component_variable:
adom
component-id
layout-id
variable
params for report_config_layout_footer:
adom
footer
layout-id
params for report_config_layout_header:
adom
header
layout-id
params for report_config_layoutfolder:
adom
layout-folder
params for report_config_macro:
adom
macro
params for report_config_output:
adom
output
params for report_config_output_emailrecipients:
adom
email-recipients
output-name
params for report_config_schedule:
adom
schedule
params for report_config_schedule_addressfilter:
address-filter
adom
schedule_name
params for report_config_schedule_devices:
adom
devices
schedule_name
params for report_config_schedule_filter:
adom
filter
schedule_name
params for report_config_schedule_reportlayout:
adom
report-layout
schedule_name
Notes
-----
.. note::
- Selector is a mandatory parameter for the module, and the params is varying depending on the selector.
- Semantic description for the module: rename ``self`` as new ``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: Rename a resource.
connection: httpapi
hosts: fortianalyzers
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
tasks:
- name: Create device group table.
fortinet.fortianalyzer.faz_dvmdb_group:
adom: root
dvmdb_group:
name: foogroup
os_type: unknown
type: normal
state: present
- name: Rename device group table.
fortinet.fortianalyzer.faz_rename:
rename:
selector: dvmdb_group
self:
adom: root
group: foogroup
target:
name: "foogroup_renamed"
- name: Get device group table information.
fortinet.fortianalyzer.faz_fact:
facts:
selector: dvmdb_group
params:
adom: root
group: foogroup
register: info
failed_when: info.rc == 0
- name: Delete device group table.
fortinet.fortianalyzer.faz_dvmdb_group:
adom: root
state: absent
dvmdb_group:
name: foogroup_renamed
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: intsample: 0
version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current versiontype: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Maxx Liu (@MaxxLiu22)
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)