#!/usr/bin/python # coding: utf-8 -*- # Copyright: (c) 2018, Adrien Fleury # 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 author: "Adrien Fleury (@fleu42)" short_description: create, update, or destroy Automation Platform Controller inventory source. description: - Create, update, or destroy Automation Platform Controller inventory source. See U(https://www.ansible.com/tower) for an overview. options: name: description: - The name to use for the inventory source. required: True type: str new_name: description: - A new name for this assets (will rename the asset) type: str description: description: - The description to use for the inventory source. type: str inventory: description: - Inventory name, ID, or named URL the group should be made a member of. required: True type: str source: description: - The source to use for this group. choices: [ "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ] type: str source_path: description: - For an SCM based inventory source, the source path points to the file within the repo to use as an inventory. type: str source_vars: description: - The variables or environment fields to apply to this source type. type: dict enabled_var: description: - The variable to use to determine enabled state e.g., "status.power_state" type: str enabled_value: description: - Value when the host is considered enabled, e.g., "powered_on" type: str host_filter: description: - If specified, AWX will only import hosts that match this regular expression. type: str limit: description: - Enter host, group or pattern match type: str credential: description: - Credential name, ID, or named URL to use for the source. type: str execution_environment: description: - Execution Environment name, ID, or named URL to use for the source. type: str custom_virtualenv: description: - Local absolute file path containing a custom Python virtualenv to use. - Only compatible with older versions of AWX/Controller - Deprecated, will be removed in the future type: str overwrite: description: - Delete child groups and hosts not found in source. type: bool overwrite_vars: description: - Override vars in child groups and hosts with those from external source. type: bool timeout: description: The amount of time (in seconds) to run before the task is canceled. type: int verbosity: description: The verbosity level to run this inventory source under. type: int choices: [ 0, 1, 2 ] update_on_launch: description: - Refresh inventory data from its source each time a job is run. type: bool update_cache_timeout: description: - Time in seconds to consider an inventory sync to be current. type: int source_project: description: - Project name, ID, or named URL to use as source with scm option type: str scm_branch: description: - Inventory source SCM branch. - Project must have branch override enabled. type: str state: description: - Desired state of the resource. default: "present" choices: ["present", "absent", "exists"] type: str notification_templates_started: description: - list of notifications to send on start type: list elements: str notification_templates_success: description: - list of notifications to send on success type: list elements: str notification_templates_error: description: - list of notifications to send on error type: list elements: str organization: description: - Name of the inventory source's inventory's organization. type: str extends_documentation_fragment: awx.awx.auth ''' EXAMPLES = ''' - name: Add an inventory source inventory_source: name: "source-inventory" description: Source for inventory inventory: previously-created-inventory credential: previously-created-credential overwrite: True update_on_launch: True organization: Default source_vars: private: false ''' from ..module_utils.controller_api import ControllerAPIModule from json import dumps def main(): # Any additional arguments that are not fields of the item can be added here argument_spec = dict( name=dict(required=True), new_name=dict(), description=dict(), inventory=dict(required=True), # # How do we handle manual and file? The controller does not seem to be able to activate them # source=dict(choices=["scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights"]), source_path=dict(), source_vars=dict(type='dict'), enabled_var=dict(), enabled_value=dict(), host_filter=dict(), limit=dict(), credential=dict(), execution_environment=dict(), custom_virtualenv=dict(), organization=dict(), overwrite=dict(type='bool'), overwrite_vars=dict(type='bool'), timeout=dict(type='int'), verbosity=dict(type='int', choices=[0, 1, 2]), update_on_launch=dict(type='bool'), update_cache_timeout=dict(type='int'), source_project=dict(), scm_branch=dict(type='str'), notification_templates_started=dict(type="list", elements='str'), notification_templates_success=dict(type="list", elements='str'), notification_templates_error=dict(type="list", elements='str'), state=dict(choices=['present', 'absent', 'exists'], default='present'), ) # Create a module for ourselves module = ControllerAPIModule(argument_spec=argument_spec) # Extract our parameters name = module.params.get('name') new_name = module.params.get('new_name') inventory = module.params.get('inventory') organization = module.params.get('organization') credential = module.params.get('credential') ee = module.params.get('execution_environment') source_project = module.params.get('source_project') state = module.params.get('state') 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, check_exists=(state == 'exists'), **{ 'data': { 'inventory': inventory_object['id'], } } ) if state == 'absent': # If the state was absent we can let the module delete it if needed, the module will handle exiting from this module.delete_if_needed(inventory_source_object) # Attempt to look up associated field items the user specified. association_fields = {} notifications_start = module.params.get('notification_templates_started') if notifications_start is not None: association_fields['notification_templates_started'] = [] for item in notifications_start: association_fields['notification_templates_started'].append(module.resolve_name_to_id('notification_templates', item)) notifications_success = module.params.get('notification_templates_success') if notifications_success is not None: association_fields['notification_templates_success'] = [] for item in notifications_success: association_fields['notification_templates_success'].append(module.resolve_name_to_id('notification_templates', item)) notifications_error = module.params.get('notification_templates_error') if notifications_error is not None: association_fields['notification_templates_error'] = [] for item in notifications_error: association_fields['notification_templates_error'].append(module.resolve_name_to_id('notification_templates', item)) # Create the data that gets sent for create and update inventory_source_fields = { 'name': new_name if new_name else name, 'inventory': inventory_object['id'], } # Attempt to look up the related items the user specified (these will fail the module if not found) if credential is not None: inventory_source_fields['credential'] = module.resolve_name_to_id('credentials', credential) if ee is not None: inventory_source_fields['execution_environment'] = module.resolve_name_to_id('execution_environments', ee) if source_project is not None: source_project_object = module.get_one('projects', name_or_id=source_project, data=lookup_data) if not source_project_object: module.fail_json(msg='The specified source project, {0}, was not found.'.format(lookup_data)) inventory_source_fields['source_project'] = source_project_object['id'] OPTIONAL_VARS = ( 'description', 'source', 'source_path', 'source_vars', 'overwrite', 'overwrite_vars', 'custom_virtualenv', 'timeout', 'verbosity', 'update_on_launch', 'update_cache_timeout', 'enabled_var', 'enabled_value', 'host_filter', 'scm_branch', 'limit', ) # Layer in all remaining optional information for field_name in OPTIONAL_VARS: field_val = module.params.get(field_name) if field_val is not None: inventory_source_fields[field_name] = field_val # Attempt to JSON encode source vars if inventory_source_fields.get('source_vars', None): inventory_source_fields['source_vars'] = dumps(inventory_source_fields['source_vars']) # Sanity check on arguments if state == 'present' and not inventory_source_object and not inventory_source_fields['source']: module.fail_json(msg="If creating a new inventory source, the source param must be present") # If the state was present we can let the module build or update the existing inventory_source_object, this will return on its own module.create_or_update_if_needed( inventory_source_object, inventory_source_fields, endpoint='inventory_sources', item_type='inventory source', associations=association_fields ) if __name__ == '__main__': main()