summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/ise/plugins/modules/upgrade_stage_start.py
blob: 5d6b248eb7ee146a0a715c60ce2f54b2c1c11f4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#!/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
short_description: Resource module for Upgrade Stage Start
description:
- Manage operation create of the resource Upgrade Stage Start.
- API to initiate staging orcheastration from PPAN.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.ise.module
author: Rafael Campos (@racampos)
options:
  hostnames:
    description: Upgrade Stage Start's hostnames.
    elements: str
    type: list
  preCheckReportID:
    description: Upgrade Stage Start's preCheckReportID.
    type: str
  reTrigger:
    description: ReTrigger flag.
    type: bool
  upgradeType:
    description: Upgrade Stage Start's upgradeType.
    type: str
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
  - SDK Method used are
    fullupgrade.Fullupgrade.initiate_staging_on_p_p_a_n,

  - Paths used are
    post /api/v1/upgrade/stage/start-stage,

"""

EXAMPLES = r"""
- name: Create
  cisco.ise.upgrade_stage_start:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    hostnames:
    - string
    preCheckReportID: string
    reTrigger: true
    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"
      }
    ]
"""