summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-05 16:18:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-06-05 16:18:34 +0000
commit3667197efb7b18ec842efd504785965911f8ac4b (patch)
tree0b986a4bc6879d080b100666a97cdabbc9ca1f28 /ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py
parentAdding upstream version 9.5.1+dfsg. (diff)
downloadansible-1f02d92b7a8d732f4e9bbdeb50c68dd718d53d00.tar.xz
ansible-1f02d92b7a8d732f4e9bbdeb50c68dd718d53d00.zip
Adding upstream version 10.0.0+dfsg.upstream/10.0.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py')
-rw-r--r--ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py53
1 files changed, 53 insertions, 0 deletions
diff --git a/ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py b/ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py
new file mode 100644
index 000000000..df27e55ef
--- /dev/null
+++ b/ansible_collections/cisco/ise/plugins/modules/upgrade_proceed_info.py
@@ -0,0 +1,53 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+DOCUMENTATION = r"""
+---
+module: upgrade_proceed_info
+short_description: Information module for Upgrade Proceed
+description:
+- Get the status of upgrade process for the requested nodes
+version_added: '1.0.0'
+extends_documentation_fragment:
+ - cisco.ise.module_info
+author: Rafael Campos (@racampos)
+options:
+ preCheckReportID:
+ description: preCheckReportID.
+ type: str
+requirements:
+- ciscoisesdk >= 2.2.1
+- python >= 3.5
+notes:
+ - SDK Method used are
+ full_upgrade.FullUpgrade.proceed_status,
+ - Paths used are
+ get /api/v1/upgrade/proceed/get-status,
+
+"""
+
+EXAMPLES = r"""
+- name: Get status of upgrade process for the requested nodes
+ cisco.ise.upgrade_proceed_info:
+ ise_hostname: "{{ise_hostname}}"
+ ise_username: "{{ise_username}}"
+ ise_password: "{{ise_password}}"
+ ise_verify: "{{ise_verify}}"
+ preCheckReportID: string
+ register: result
+"""
+
+RETURN = r"""
+ise_response:
+ description: A dictionary or list with the response returned by the Cisco ISE Python SDK
+ returned: always
+ type: dict
+ sample: >
+ {
+ "message": "string",
+ "preCheckReportID": "string"
+ }
+"""