mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 10:00:01 -03:30
0815f935ca
Providing defaults for API parameters where the API already provides defaults leads to some confusing scenarios, because we end up always sending those collection-defaulted fields in the request even if the field isn't provided by the user. For example, we previously set the `scm_type` default to 'manual' and someone using the collection to update a project who does not explicitly include the `scm_type` every time they call the module, would inadvertently change the `scm_type` of the project back to 'manual' which is surprising behavior. This change removes the collection defaults for API parameters, unless they differed from the API default. We let the API handle the defaults or otherwise ignore fields not given by the user so that the user does not end up changing unexpected fields when they use a module. Signed-off-by: Rick Elrod <rick@elrod.me>
147 lines
4.5 KiB
Python
147 lines
4.5 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8 -*-
|
|
|
|
# (c) 2020, Bianca Henderson <bianca@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': ['preview'], 'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: inventory_source_update
|
|
author: "Bianca Henderson (@beeankha)"
|
|
short_description: Update inventory source(s).
|
|
description:
|
|
- Update Automation Platform Controller inventory source(s). See
|
|
U(https://www.ansible.com/tower) for an overview.
|
|
options:
|
|
name:
|
|
description:
|
|
- The name or id of the inventory source to update.
|
|
required: True
|
|
type: str
|
|
aliases:
|
|
- inventory_source
|
|
inventory:
|
|
description:
|
|
- Name or id of the inventory that contains the inventory source(s) to update.
|
|
required: True
|
|
type: str
|
|
organization:
|
|
description:
|
|
- Name of the inventory source's inventory's organization.
|
|
type: str
|
|
wait:
|
|
description:
|
|
- Wait for the job to complete.
|
|
default: False
|
|
type: bool
|
|
interval:
|
|
description:
|
|
- The interval to request an update from the controller.
|
|
required: False
|
|
default: 2
|
|
type: float
|
|
timeout:
|
|
description:
|
|
- If waiting for the job to complete this will abort after this
|
|
amount of seconds
|
|
type: int
|
|
extends_documentation_fragment: awx.awx.auth
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Update a single inventory source
|
|
inventory_source_update:
|
|
name: "Example Inventory Source"
|
|
inventory: "My Inventory"
|
|
organization: Default
|
|
|
|
- name: Update all inventory sources
|
|
inventory_source_update:
|
|
name: "{{ item }}"
|
|
inventory: "My Other Inventory"
|
|
loop: "{{ query('awx.awx.controller_api', 'inventory_sources', query_params={ 'inventory': 30 }, return_ids=True ) }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
id:
|
|
description: id of the inventory update
|
|
returned: success
|
|
type: int
|
|
sample: 86
|
|
status:
|
|
description: status of the inventory update
|
|
returned: success
|
|
type: str
|
|
sample: pending
|
|
'''
|
|
|
|
from ..module_utils.controller_api import ControllerAPIModule
|
|
|
|
|
|
def main():
|
|
# Any additional arguments that are not fields of the item can be added here
|
|
argument_spec = dict(
|
|
name=dict(required=True, aliases=['inventory_source']),
|
|
inventory=dict(required=True),
|
|
organization=dict(),
|
|
wait=dict(default=False, type='bool'),
|
|
interval=dict(default=2.0, type='float'),
|
|
timeout=dict(type='int'),
|
|
)
|
|
|
|
# Create a module for ourselves
|
|
module = ControllerAPIModule(argument_spec=argument_spec)
|
|
|
|
# Extract our parameters
|
|
name = module.params.get('name')
|
|
inventory = module.params.get('inventory')
|
|
organization = module.params.get('organization')
|
|
wait = module.params.get('wait')
|
|
interval = module.params.get('interval')
|
|
timeout = module.params.get('timeout')
|
|
|
|
lookup_data = {}
|
|
if organization:
|
|
lookup_data['organization'] = module.resolve_name_to_id('organizations', organization)
|
|
inventory_object = module.get_one('inventories', name_or_id=inventory, data=lookup_data)
|
|
|
|
if not inventory_object:
|
|
module.fail_json(msg='The specified inventory, {0}, was not found.'.format(lookup_data))
|
|
|
|
inventory_source_object = module.get_one('inventory_sources', name_or_id=name, data={'inventory': inventory_object['id']})
|
|
|
|
if not inventory_source_object:
|
|
module.fail_json(msg='The specified inventory source was not found.')
|
|
|
|
# Sync the inventory source(s)
|
|
inventory_source_update_results = module.post_endpoint(inventory_source_object['related']['update'])
|
|
|
|
if inventory_source_update_results['status_code'] != 202:
|
|
module.fail_json(msg="Failed to update inventory source, see response for details", response=inventory_source_update_results)
|
|
|
|
module.json_output['changed'] = True
|
|
module.json_output['id'] = inventory_source_update_results['json']['id']
|
|
module.json_output['status'] = inventory_source_update_results['json']['status']
|
|
|
|
if not wait:
|
|
module.exit_json(**module.json_output)
|
|
|
|
# Invoke wait function
|
|
module.wait_on_url(
|
|
url=inventory_source_update_results['json']['url'], object_name=inventory_object, object_type='inventory_update', timeout=timeout, interval=interval
|
|
)
|
|
|
|
module.exit_json(**module.json_output)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|