summaryrefslogtreecommitdiffstats
path: root/awx_collection/plugins/modules/receive.py
blob: e941b648ec29b966164fb66d6fbbb36b74b7c165 (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
#!/usr/bin/python
# coding: utf-8 -*-

# (c) 2017, John Westcott IV <john.westcott.iv@redhat.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import absolute_import, division, print_function

__metaclass__ = type


ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['deprecated'], 'supported_by': 'community'}


DOCUMENTATION = '''
---
module: receive
deprecated:
  removed_in: "14.0.0"
  why: Deprecated in favor of upcoming C(_export) module.
  alternative: Once published, use M(tower_export) instead.
author: "John Westcott IV (@john-westcott-iv)"
short_description: Receive assets from Automation Platform Controller.
description:
    - Receive assets from Automation Platform Controller. See
      U(https://www.ansible.com/tower) for an overview.
options:
    all:
      description:
        - Export all assets
      type: bool
      default: 'False'
    organization:
      description:
        - List of organization names to export
      default: []
      type: list
      elements: str
    user:
      description:
        - List of user names to export
      default: []
      type: list
      elements: str
    team:
      description:
        - List of team names to export
      default: []
      type: list
      elements: str
    credential_type:
      description:
        - List of credential type names to export
      default: []
      type: list
      elements: str
    credential:
      description:
        - List of credential names to export
      default: []
      type: list
      elements: str
    notification_template:
      description:
        - List of notification template names to export
      default: []
      type: list
      elements: str
    inventory:
      description:
        - List of inventory names to export
      default: []
      type: list
      elements: str
    project:
      description:
        - List of project names to export
      default: []
      type: list
      elements: str
    job_template:
      description:
        - List of job template names to export
      default: []
      type: list
      elements: str
    workflow:
      description:
        - List of workflow names to export
      default: []
      type: list
      elements: str

requirements:
  - "ansible-tower-cli >= 3.3.0"

notes:
  - Specifying a name of "all" for any asset type will export all items of that asset type.

extends_documentation_fragment: awx.awx.auth_legacy
'''

EXAMPLES = '''
- name: Export all Automation Platform Controller assets
  receive:
    all: True
    tower_config_file: "~/tower_cli.cfg"

- name: Export all inventories
  receive:
    inventory:
      - all

- name: Export a job template named "My Template" and all Credentials
  receive:
    job_template:
      - "My Template"
    credential:
      - all
'''

RETURN = '''
assets:
    description: The exported assets
    returned: success
    type: dict
    sample: [ {}, {} ]
'''

from ..module_utils.tower_legacy import TowerLegacyModule, tower_auth_config, HAS_TOWER_CLI

try:
    from tower_cli.cli.transfer.receive import Receiver
    from tower_cli.cli.transfer.common import SEND_ORDER
    from tower_cli.utils.exceptions import TowerCLIError

    from tower_cli.conf import settings

    TOWER_CLI_HAS_EXPORT = True
except ImportError:
    TOWER_CLI_HAS_EXPORT = False


def main():
    argument_spec = dict(
        all=dict(type='bool', default=False),
        credential=dict(type='list', default=[], elements='str'),
        credential_type=dict(type='list', default=[], elements='str'),
        inventory=dict(type='list', default=[], elements='str'),
        job_template=dict(type='list', default=[], elements='str'),
        notification_template=dict(type='list', default=[], elements='str'),
        organization=dict(type='list', default=[], elements='str'),
        project=dict(type='list', default=[], elements='str'),
        team=dict(type='list', default=[], elements='str'),
        user=dict(type='list', default=[], elements='str'),
        workflow=dict(type='list', default=[], elements='str'),
    )

    module = TowerLegacyModule(argument_spec=argument_spec, supports_check_mode=False)

    module.deprecate(msg="This module is deprecated and will be replaced by the AWX CLI export command.", version="awx.awx:14.0.0")

    if not HAS_TOWER_CLI:
        module.fail_json(msg='ansible-tower-cli required for this module')

    if not TOWER_CLI_HAS_EXPORT:
        module.fail_json(msg='ansible-tower-cli version does not support export')

    export_all = module.params.get('all')
    assets_to_export = {}
    for asset_type in SEND_ORDER:
        assets_to_export[asset_type] = module.params.get(asset_type)

    result = dict(
        assets=None,
        changed=False,
        message='',
    )

    tower_auth = tower_auth_config(module)
    with settings.runtime_values(**tower_auth):
        try:
            receiver = Receiver()
            result['assets'] = receiver.export_assets(all=export_all, asset_input=assets_to_export)
            module.exit_json(**result)
        except TowerCLIError as e:
            result['message'] = e.message
            module.fail_json(msg='Receive Failed', **result)


if __name__ == '__main__':
    main()