summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py')
-rw-r--r--ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py64
1 files changed, 64 insertions, 0 deletions
diff --git a/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py b/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py
new file mode 100644
index 000000000..2d7f92cf3
--- /dev/null
+++ b/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start_info.py
@@ -0,0 +1,64 @@
+#!/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_stage_start_info
+short_description: Information module for Upgrade Stage Start
+description:
+- Get all Upgrade Stage Start.
+- Get the status of upgrade stage 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 query parameter.
+ type: str
+requirements:
+- ciscoisesdk >= 2.2.1
+- python >= 3.5
+notes:
+ - SDK Method used are
+ fullupgrade.Fullupgrade.stage_status,
+
+ - Paths used are
+ get /api/v1/upgrade/stage/get-status,
+
+"""
+
+EXAMPLES = r"""
+- name: Get all Upgrade Stage Start
+ cisco.ise.upgrade_stage_start_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: list
+ elements: dict
+ sample: >
+ [
+ {
+ "dbStatus": "string",
+ "message": "string",
+ "node": "string",
+ "percentage": 0,
+ "progressMsg": "string",
+ "status": "string"
+ }
+ ]
+"""