:source: fmgd_rename.py :orphan: .. _fmgd_rename: fmgd_rename -- Rename An Object. +++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.0.0 .. contents:: :local: :depth: 1 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 v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 Parameters ---------- .. raw:: html 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: 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 an object hosts: fortimanagers connection: httpapi vars: device_name: "FGVMMLTMXXXXX" vdom_name: "root" tasks: - name: Rename an object in FortiManager Device by using fmgd_rename module. fortinet.fmgdevice.fmgd_rename: rename: selector: "antivirus_exemptlist" self: vdom: "{{ vdom_name }}" device: "{{ device_name }}" exempt_list: "old_name" target: name: "new_name" 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) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - 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.