: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 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 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)