diff options
Diffstat (limited to 'ansible_collections/cisco/ise/plugins/modules/upgrade_stage_cancel.py')
-rw-r--r-- | ansible_collections/cisco/ise/plugins/modules/upgrade_stage_cancel.py | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_cancel.py b/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_cancel.py new file mode 100644 index 000000000..8399cfb38 --- /dev/null +++ b/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_cancel.py @@ -0,0 +1,73 @@ +#!/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_cancel +short_description: Resource module for Upgrade Stage Cancel +description: +- Manage operation create of the resource Upgrade Stage Cancel. +- API to cancel staging process of specified nodes from PPAN. +version_added: '1.0.0' +extends_documentation_fragment: + - cisco.ise.module +author: Rafael Campos (@racampos) +options: + hostnames: + description: Upgrade Stage Cancel's hostnames. + elements: str + type: list + preCheckReportID: + description: Upgrade Stage Cancel's preCheckReportID. + type: str + upgradeType: + description: Upgrade Stage Cancel's upgradeType. + type: str +requirements: +- ciscoisesdk >= 2.2.1 +- python >= 3.5 +notes: + - SDK Method used are + fullupgrade.Fullupgrade.cancel_staging_on_p_p_a_n, + + - Paths used are + post /api/v1/upgrade/stage/cancel-stage, + +""" + +EXAMPLES = r""" +- name: Create + cisco.ise.upgrade_stage_cancel: + ise_hostname: "{{ise_hostname}}" + ise_username: "{{ise_username}}" + ise_password: "{{ise_password}}" + ise_verify: "{{ise_verify}}" + state: present + hostnames: + - string + preCheckReportID: string + upgradeType: string + +""" + +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" + } + ] +""" |