mirror of
https://github.com/ansible/awx.git
synced 2026-01-11 10:00:01 -03:30
55a7591f89
Bump migrations and delete some files Resolve remaining conflicts Fix requirements Flake8 fixes Prefer devel changes for schema Use correct versions Remove sso connected stuff Update to modern actions and collection fixes Remove unwated alias Version problems in actions Fix more versioning problems Update warning string Messed it up again Shorten exception More removals Remove pbr license Remove tests deleted in devel Remove unexpected files Remove some content missed in the rebase Use sleep_task from devel Restore devel live conftest file Add in settings that got missed Prefer devel version of collection test Finish repairing .github path Remove unintended test file duplication Undo more unintended file additions
87 lines
2.6 KiB
Python
87 lines
2.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2020, Ansible by Red Hat, Inc
|
|
# 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
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Automation Platform Controller documentation fragment
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
host:
|
|
description: The network address of your Automation Platform Controller host.
|
|
env:
|
|
- name: CONTROLLER_HOST
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Collection name change
|
|
alternatives: 'TOWER_HOST, AAP_HOSTNAME'
|
|
username:
|
|
description: The user that you plan to use to access inventories on the controller.
|
|
env:
|
|
- name: CONTROLLER_USERNAME
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Collection name change
|
|
alternatives: 'TOWER_USERNAME, AAP_USERNAME'
|
|
password:
|
|
description: The password for your controller user.
|
|
env:
|
|
- name: CONTROLLER_PASSWORD
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Collection name change
|
|
alternatives: 'TOWER_PASSWORD, AAP_PASSWORD'
|
|
aap_token:
|
|
description:
|
|
- The OAuth token to use.
|
|
env:
|
|
- name: AAP_TOKEN
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Collection name change
|
|
verify_ssl:
|
|
description:
|
|
- Specify whether Ansible should verify the SSL certificate of the controller host.
|
|
- Defaults to True, but this is handled by the shared module_utils code
|
|
type: bool
|
|
env:
|
|
- name: CONTROLLER_VERIFY_SSL
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Collection name change
|
|
alternatives: 'TOWER_VERIFY_SSL, AAP_VALIDATE_CERTS'
|
|
aliases: [ validate_certs ]
|
|
request_timeout:
|
|
description:
|
|
- Specify the timeout Ansible should use in requests to the controller host.
|
|
- Defaults to 10 seconds
|
|
- This will not work with the export or import modules.
|
|
type: float
|
|
env:
|
|
- name: CONTROLLER_REQUEST_TIMEOUT
|
|
deprecated:
|
|
collection_name: 'awx.awx'
|
|
version: '4.0.0'
|
|
why: Support for AAP variables
|
|
alternatives: 'AAP_REQUEST_TIMEOUT'
|
|
aliases: [ aap_request_timeout ]
|
|
notes:
|
|
- If no I(config_file) is provided we will attempt to use the tower-cli library
|
|
defaults to find your host information.
|
|
- I(config_file) should be in the following format
|
|
host=hostname
|
|
username=username
|
|
password=password
|
|
'''
|