From 18bd2207b6c1977e99a93673a7be099e23f0f547 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 26 Jun 2024 08:22:20 +0200 Subject: Merging upstream version 10.1.0+dfsg. Signed-off-by: Daniel Baumann --- .../ieisystem/inmanage/docs/backup_module.rst | 355 +++++++++++++++++++++ 1 file changed, 355 insertions(+) create mode 100644 ansible_collections/ieisystem/inmanage/docs/backup_module.rst (limited to 'ansible_collections/ieisystem/inmanage/docs/backup_module.rst') diff --git a/ansible_collections/ieisystem/inmanage/docs/backup_module.rst b/ansible_collections/ieisystem/inmanage/docs/backup_module.rst new file mode 100644 index 000000000..1b972ba72 --- /dev/null +++ b/ansible_collections/ieisystem/inmanage/docs/backup_module.rst @@ -0,0 +1,355 @@ +.. Document meta + +:orphan: + +.. Anchors + +.. _ansible_collections.ieisystem.inmanage.backup_module: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +ieisystem.inmanage.backup -- Backup server settings ++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `ieisystem.inmanage collection `_. + + To install it use: :code:`ansible-galaxy collection install ieisystem.inmanage`. + + To use it in a playbook, specify: :code:`ieisystem.inmanage.backup`. + +.. version_added + +.. versionadded:: 1.0.0 of ieisystem.inmanage + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Backup server settings on ieisystem Server. + + +.. Aliases + + +.. Requirements + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- Python 3.7+ +- inManage + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ bak_file + +
+ string + / required
+ 		+ +
Backup file or bak folder.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ item + +
+ string + / required
+ 		+
    Choices: +
  • all
    • +
  • network
    • +
  • service
    • +
  • ntp
    • +
  • snmptrap
    • +
  • dns
    • +
  • smtp
    • +
  • ad
    • +
  • ldap
    • +
  • user
    • +
  • bios
    • +
  • kvm
    • +
  • ipmi
    • +
  • authentication
    • +
  • syslog
    • +
  • ncsi
    • +
+ 		+
Export item.
+
The values for M5 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', 'user', 'bios'.
+
The values for M6 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'kvm', 'ipmi', 'authentication', 'syslog'.
+
The values for M7 modules are 'all', 'network', 'service', 'syslog', 'ncsi'.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ provider + +
+ dictionary +
+ 		+ +
A dict object containing connection details.
+
+
+ host + +
+ string +
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ +.. Notes + +Notes +----- + +.. note:: + - Does not support ``check_mode``. + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: Backup test + hosts: inmanage + connection: local + gather_facts: false + vars: + inmanage: + host: "{{ ansible_ssh_host }}" + username: "{{ username }}" + password: "{{ password }}" + + tasks: + + - name: "Backup server settings" + ieisystem.inmanage.backup: + bak_file: "/home/wbs/" + item: "all" + provider: "{{ inmanage }}" + + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ changed + +
+ boolean +
+ 		always +
Check to see if a change was made on the device.
+
+
+
+ message + +
+ string +
+ 		always +
Messages returned after module execution.
+
+
+
+ state + +
+ string +
+ 		always +
Status after module execution.
+
+
+

+ +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- WangBaoshan (@ieisystem) + + + +.. Parsing errors + -- cgit v1.2.3