sean_m_sullivan.controller_configuration.controller_export_diff (2.2.6) — module

Install collection

Install with ansible-galaxy collection install sean_m_sullivan.controller_configuration:==2.2.6

Add to requirements.yml

  collections:
    - name: sean_m_sullivan.controller_configuration
      version: 2.2.6

Description

Compare controller configuration resources with those defined in code.

Requirements

• awxkit >= 9.3.0
• awx.awx or ansible.controller collection

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get differential on projects and orgs.
  infra.controller_configuration.controller_export_diff:
    organizations: all
    projects: all
    compare_items:
      organizations:
        - name: Satellite
        - name: Default
      projects:
        - name: Test Project
          scm_type: git
          scm_url: https://github.com/ansible/tower-example.git
          scm_branch: master
          scm_clean: true
          description: Test Project 1
          organization:
            name: Default
          wait: true
          update_project: true
        - name: Test Inventory source project with credential
          scm_type: git
          scm_url: https://github.com/ansible/ansible-examples.git
          description: ansible-examples
          organization:
              name: Satellite
          credential: gitlab-personal-access-token for satqe_auto_droid
          wait: false
    controller_host: https://controller
    controller_username: admin
    controller_password: secret123
    validate_certs: false
  register: export_results

Inputs

    
all:
    default: 'False'
    description:
    - Export all assets
    type: bool

teams:
    description:
    - team names to export
    elements: str
    type: list

users:
    description:
    - user names to export
    elements: str
    type: list

projects:
    description:
    - project names to export
    elements: str
    type: list

inventory:
    description:
    - inventory names to export
    elements: str
    type: list

schedules:
    description:
    - schedule names to export
    elements: str
    type: list

set_absent:
    default: true
    description:
    - Set state of items not in the compare list to 'absent'
    type: bool

credentials:
    description:
    - credential names to export
    elements: str
    type: list

applications:
    description:
    - OAuth2 application names to export
    elements: str
    type: list

with_present:
    default: true
    description:
    - Include items in the original compare list in the output, and set state to 'present'
    type: bool

compare_items:
    description:
    - The dict of list objects to compare the api_list to.
    - This should match the dictionary name for the object above, and will be used for
      comparison.
    required: true
    type: dict

job_templates:
    description:
    - job template names to export
    elements: str
    type: list

organizations:
    description:
    - organization names to export
    elements: str
    type: list

validate_certs:
    aliases:
    - tower_verify_ssl
    description:
    - Whether to allow insecure connections to AWX.
    - If C(no), SSL certificates will not be validated.
    - This should only be used on personally controlled sites using self-signed certificates.
    - If value not set, will try environment variable C(CONTROLLER_VERIFY_SSL) and then
      config files
    type: bool

controller_host:
    aliases:
    - tower_host
    description:
    - URL to your Automation Platform Controller instance.
    - If value not set, will try environment variable C(CONTROLLER_HOST) and then config
      files
    - If value not specified by any means, the value of C(127.0.0.1) will be used
    type: str

credential_types:
    description:
    - credential type names to export
    elements: str
    type: list

inventory_sources:
    description:
    - inventory soruces to export
    elements: str
    type: list

controller_password:
    aliases:
    - tower_password
    description:
    - Password for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_PASSWORD) and then
      config files
    type: str

controller_username:
    aliases:
    - tower_username
    description:
    - Username for your controller instance.
    - If value not set, will try environment variable C(CONTROLLER_USERNAME) and then
      config files
    type: str

controller_oauthtoken:
    aliases:
    - tower_oauthtoken
    description:
    - The OAuth token to use.
    - This value can be in one of two formats.
    - A string which is the token itself. (i.e. bqV5txm97wqJqtkxlMkhQz0pKhRMMX)
    - A dictionary structure as returned by the token module.
    - If value not set, will try environment variable C(CONTROLLER_OAUTH_TOKEN) and then
      config files
    type: raw
    version_added: 3.7.0
    version_added_collection: sean_m_sullivan.controller_configuration

controller_config_file:
    aliases:
    - tower_config_file
    description:
    - Path to the controller config file.
    - If provided, the other locations for config files will not be considered.
    type: path

execution_environments:
    description:
    - execution environment names to export
    elements: str
    type: list

notification_templates:
    description:
    - notification template names to export
    elements: str
    type: list

workflow_job_templates:
    description:
    - workflow names to export
    elements: str
    type: list