Test Logging Configuration

post

/api/v2/settings/logging/test/

Request

Supported Media Types
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : AD_HOC_COMMANDS
Type: array
List of modules allowed to be used by ad-hoc jobs.
Show Source
Nested Schema : AUTH_LDAP_1_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_1_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_1_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_1_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_1_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_1_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_1_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_1_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AUTH_LDAP_2_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_2_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_2_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_2_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_2_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_2_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_2_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_2_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AUTH_LDAP_3_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_3_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_3_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_3_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_3_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_3_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_3_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_3_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AUTH_LDAP_4_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_4_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_4_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_4_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_4_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_4_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_4_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_4_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AUTH_LDAP_5_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_5_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_5_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_5_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_5_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_5_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_5_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_5_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AUTH_LDAP_CONNECTION_OPTIONS
Type: object
Additional options to set for the LDAP connection. LDAP referrals are disabled by default (to prevent certain LDAP queries from hanging with AD). Option names should be strings (e.g. "OPT_REFERRALS"). Refer to https://www.python-ldap.org/doc/html/ldap.html#options for possible options and values that can be set.
Nested Schema : AUTH_LDAP_GROUP_SEARCH
Type: array
Users are mapped to organizations based on their membership in LDAP groups. This setting defines the LDAP search query to find groups. Unlike the user search, group search does not support LDAPSearchUnion.
Show Source
Nested Schema : AUTH_LDAP_GROUP_TYPE_PARAMS
Type: object
Key value parameters to send the chosen group type init method.
Nested Schema : AUTH_LDAP_ORGANIZATION_MAP
Type: object
Mapping between organization admins/users and LDAP groups. This controls which users are placed into which Tower organizations relative to their LDAP group memberships. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_TEAM_MAP
Type: object
Mapping between team members (users) and LDAP groups. Configuration details are available in the Ansible Tower documentation.
Nested Schema : AUTH_LDAP_USER_ATTR_MAP
Type: object
Mapping of LDAP user schema to Tower API user attributes. The default setting is valid for ActiveDirectory but users with other LDAP configurations may need to change the values. Refer to the Ansible Tower documentation for additional details.
Nested Schema : AUTH_LDAP_USER_FLAGS_BY_GROUP
Type: object
Retrieve users from a given group. At this time, superuser and system auditors are the only groups supported. Refer to the Ansible Tower documentation for more detail.
Nested Schema : AUTH_LDAP_USER_SEARCH
Type: array
LDAP search query to find users. Any user that matches the given pattern will be able to login to Tower. The user should also be mapped into a Tower organization (as defined in the AUTH_LDAP_ORGANIZATION_MAP setting). If multiple search queries need to be supported use of "LDAPUnion" is possible. See Tower documentation for details.
Show Source
Nested Schema : AWX_ANSIBLE_CALLBACK_PLUGINS
Type: array
List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line.
Show Source
Nested Schema : AWX_PROOT_HIDE_PATHS
Type: array
Additional paths to hide from isolated processes. Enter one path per line.
Show Source
Nested Schema : AWX_PROOT_SHOW_PATHS
Type: array
List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line.
Show Source
Nested Schema : AWX_TASK_ENV
Type: object
Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending.
Nested Schema : CUSTOM_VENV_PATHS
Type: array
Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line.
Show Source
Nested Schema : LOG_AGGREGATOR_LOGGERS
Type: array
List of loggers that will send HTTP logs to the collector, these can include any or all of: awx - service logs activity_stream - activity stream records job_events - callback data from Ansible job events system_tracking - facts gathered from scan jobs.
Show Source
Nested Schema : OAUTH2_PROVIDER
Type: object
Dictionary for customizing OAuth 2 timeouts, available items are `ACCESS_TOKEN_EXPIRE_SECONDS`, the duration of access tokens in the number of seconds, `AUTHORIZATION_CODE_EXPIRE_SECONDS`, the duration of authorization codes in the number of seconds, and `REFRESH_TOKEN_EXPIRE_SECONDS`, the duration of refresh tokens, after expired access tokens, in the number of seconds.
Nested Schema : PROXY_IP_ALLOWED_LIST
Type: array
If Tower is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which Tower should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')
Show Source
Nested Schema : REMOTE_HOST_HEADERS
Type: array
HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as "HTTP_X_FORWARDED_FOR", if behind a reverse proxy. See the "Proxy Support" section of the Adminstrator guide for more details.
Show Source
Nested Schema : SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS
Type: object
Extra arguments for Google OAuth2 login. You can restrict it to only allow a single domain to authenticate, even if the user is logged in with multple Google accounts. Refer to the Ansible Tower documentation for more detail.
Nested Schema : SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS
Type: array
Update this setting to restrict the domains who are allowed to login using Google OAuth2.
Show Source
Nested Schema : SOCIAL_AUTH_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_SAML_ENABLED_IDPS
Type: object
Configure the Entity ID, SSO URL and certificate for each identity provider (IdP) in use. Multiple SAML IdPs are supported. Some IdPs may provide user data using attribute names that differ from the default OIDs. Attribute names may be overridden for each IdP. Refer to the Ansible documentation for additional details and syntax.
Nested Schema : SOCIAL_AUTH_SAML_EXTRA_DATA
Type: array
A list of tuples that maps IDP attributes to extra_attributes. Each attribute will be a list of values, even if only 1 value.
Show Source
Nested Schema : SOCIAL_AUTH_SAML_ORG_INFO
Type: object
Provide the URL, display name, and the name of your app. Refer to the Ansible Tower documentation for example syntax.
Nested Schema : SOCIAL_AUTH_SAML_ORGANIZATION_ATTR
Type: object
Used to translate user organization membership into Tower.
Nested Schema : SOCIAL_AUTH_SAML_ORGANIZATION_MAP
Type: object
Mapping to organization admins/users from social auth accounts. This setting controls which users are placed into which Tower organizations based on their username and email address. Configuration details are available in the Ansible Tower documentation.
Nested Schema : SOCIAL_AUTH_SAML_SECURITY_CONFIG
Type: object
A dict of key value pairs that are passed to the underlying python-saml security setting https://github.com/onelogin/python-saml#settings
Nested Schema : SOCIAL_AUTH_SAML_SP_EXTRA
Type: object
A dict of key value pairs to be passed to the underlying python-saml Service Provider configuration setting.
Nested Schema : SOCIAL_AUTH_SAML_SUPPORT_CONTACT
Type: object
Provide the name and email address of the support contact for your service provider. Refer to the Ansible Tower documentation for example syntax.
Nested Schema : SOCIAL_AUTH_SAML_TEAM_ATTR
Type: object
Used to translate user team membership into Tower.
Nested Schema : SOCIAL_AUTH_SAML_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_SAML_TECHNICAL_CONTACT
Type: object
Provide the name and email address of the technical contact for your service provider. Refer to the Ansible Tower documentation for example syntax.
Nested Schema : SOCIAL_AUTH_TEAM_MAP
Type: object
Mapping of team members (users) from social auth accounts. Configuration details are available in Tower documentation.
Nested Schema : SOCIAL_AUTH_USER_FIELDS
Type: array
When set to an empty list `[]`, this setting prevents new user accounts from being created. Only users who have previously logged in using social auth or have a user account with a matching email address will be able to login.
Show Source
Back to Top

Response

Supported Media Types

201 Response

403 Response

Body
Example Response (application/json)
{
    "detail":"You do not have permission to perform this action."
}

409 Response

Body
Example Response (application/json)
{
    "error":"Logging not enabled"
}
Back to Top