mirror of
https://github.com/ansible/awx.git
synced 2026-04-22 18:25:28 -02:30
105 lines
3.1 KiB
Python
105 lines
3.1 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 ]
|
|
max_retries:
|
|
description:
|
|
- Specify the max retries to be used with some connection issues.
|
|
- Defaults to 5.
|
|
- This will not work with the export or import modules.
|
|
type: int
|
|
env:
|
|
- name: AAP_MAX_RETRIES
|
|
aliases: [ aap_max_retries ]
|
|
retry_backoff_factor:
|
|
description:
|
|
- Backoff factor used when retrying connections.
|
|
- Defaults to 2.
|
|
- This will not work with the export or import modules.
|
|
type: int
|
|
env:
|
|
- name: AAP_RETRY_BACKOFF_FACTOR
|
|
aliases: [ aap_retry_backoff_factor ]
|
|
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
|
|
'''
|