11. Controller API Reference Guide¶
The automation controller API Reference Manual provides in-depth documentation for Red Hat Ansible Automation Platform’s controller REST API, including examples on how to integrate with it.
api
Models
| action_node | string minLength: 1 readOnly: true title: Action node The cluster node the activity took place on. |
| changes | string readOnly: true title: Changes A summary of the new and changed values when an object is created, updated, or deleted |
| id | integer readOnly: true title: ID |
| object1* | string minLength: 1 title: Object1 For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. |
| object2* | string minLength: 1 title: Object2 Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. |
| object_association | string readOnly: true title: Object association When present, shows the field name of the role or relationship that changed. |
| object_type | string readOnly: true title: Object type When present, shows the model on which the role or relationship was defined. |
| operation* | string title: Operation The action taken with respect to the given object(s). Array [ 5 ] |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| timestamp | string($date-time) readOnly: true title: Timestamp |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| can_cancel | boolean readOnly: true title: Can cancel |
| become_enabled | boolean default: false title: Become enabled |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| diff_mode | boolean default: false title: Diff mode |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| forks | integer default: 0 minimum: 0 title: Forks |
| host_status_counts | Host status counts{...} |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | Job env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_type | string default: run title: Job typeEnum: Array [ 2 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string default: title: Limit |
| modified | string readOnly: true title: Modified |
| module_args | string default: title: Module args |
| module_name | string default: command title: Module nameEnum: Array [ 19 ] |
| name | string minLength: 1 readOnly: true title: Name |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| verbosity | integer default: 0 title: VerbosityEnum: Array [ 6 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| ad_hoc_command | string readOnly: true title: Ad hoc command |
| changed | boolean readOnly: true title: Changed |
| counter | integer minimum: 0 readOnly: true title: Counter |
| created | string readOnly: true title: Created |
| end_line | integer minimum: 0 readOnly: true title: End line |
| event* | string title: EventEnum: Array [ 10 ] |
| event_data | Event data{...} |
| event_display | string minLength: 1 readOnly: true title: Event display |
| failed | boolean readOnly: true title: Failed |
| host | integer readOnly: true title: Host |
| host_name | string minLength: 1 readOnly: true title: Host name |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| start_line | integer minimum: 0 readOnly: true title: Start line |
| stdout | string minLength: 1 readOnly: true title: Stdout |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| verbosity | integer minimum: 0 readOnly: true title: Verbosity |
| become_enabled | boolean default: false title: Become enabled |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| diff_mode | boolean default: false title: Diff mode |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| forks | integer default: 0 minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_type | string default: run title: Job typeEnum: Array [ 2 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string default: title: Limit |
| modified | string readOnly: true title: Modified |
| module_args | string default: title: Module args |
| module_name | string default: command title: Module nameEnum: Array [ 19 ] |
| name | string minLength: 1 readOnly: true title: Name |
| related | string readOnly: true title: Related |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| verbosity | integer default: 0 title: VerbosityEnum: Array [ 6 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| description | string default: title: Description |
| enabled | boolean default: true title: Enabled Is this host online and available for running jobs? |
| instance_id | string default: maxLength: 1024 title: Instance id The value used by the remote inventory source to uniquely identify the host |
| name* | string maxLength: 512 minLength: 1 title: Name |
| variables | string default: title: Variables Host variables in JSON or YAML format. |
| hosts* | [...] |
| inventory* | integer title: Inventory Primary Key ID of inventory to add hosts to. |
| description | string minLength: 1 title: Description |
| extra_vars | Extra vars{...} |
| inventory | integer title: Inventory |
| job_tags | string minLength: 1 title: Job tags |
| jobs* | [...] |
| limit | string minLength: 1 title: Limit |
| name | string default: Bulk Job Launch maxLength: 512 title: Name |
| organization | integer title: Organization Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically. |
| scm_branch | string minLength: 1 title: Scm branch |
| skip_tags | string minLength: 1 title: Skip tags |
| description: | List of jobs to be launched, JSON. e.g. [{"unified_job_template": 7}, {"unified_job_template": 10}] |
| all_parents_must_converge | boolean default: false title: All parents must converge If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node |
| always_nodes | [...] |
| created | string readOnly: true title: Created |
| credentials | [...] |
| diff_mode | boolean title: Diff mode |
| do_not_run | boolean default: false title: Do not run Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. |
| execution_environment | integer minimum: 1 title: Execution environment |
| extra_data | Extra data{...} |
| failure_nodes | [...] |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| identifier | string maxLength: 512 title: Identifier An identifier coresponding to the workflow job template node that this node was created from. |
| instance_groups | [...] |
| inventory | integer minimum: 1 title: Inventory |
| job | integer title: Job |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| labels | [...] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| success_nodes | [...] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| type | string readOnly: true title: Type |
| unified_job_template* | integer minimum: 1 title: Unified job template Primary key of the template for this job, can be a job template or inventory source. |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| workflow_job | string title: Workflow job |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| has_active_failures | boolean readOnly: true title: Has active failures This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. |
| has_inventory_sources | boolean readOnly: true title: Has inventory sources This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. |
| hosts_with_active_failures | integer minimum: 0 readOnly: true title: Hosts with active failures This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. |
| id | integer readOnly: true title: ID |
| inventory_sources_with_failures | integer minimum: 0 readOnly: true title: Inventory sources with failures Number of external inventory sources in this inventory with failures. |
| kind | string readOnly: true title: Kind Kind of inventory being represented. Array [ 3 ] |
| limit | string title: Limit The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization* | integer title: Organization Organization containing this inventory. |
| pending_deletion | boolean readOnly: true title: Pending deletion Flag indicating the inventory is being deleted. |
| prevent_instance_group_fallback | boolean default: false title: Prevent instance group fallback If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. |
| related | string readOnly: true title: Related |
| source_vars | string title: Source vars The source_vars for the related auto-created inventory source, special to constructed inventory. |
| summary_fields | string readOnly: true title: Summary fields |
| total_groups | integer minimum: 0 readOnly: true title: Total groups This field is deprecated and will be removed in a future release. Total number of groups in this inventory. |
| total_hosts | integer minimum: 0 readOnly: true title: Total hosts This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. |
| total_inventory_sources | integer minimum: 0 readOnly: true title: Total inventory sources Total number of external inventory sources configured within this inventory. |
| type | string readOnly: true title: Type |
| update_cache_timeout | integer minimum: 0 title: Update cache timeout The cache timeout for the related auto-created inventory source, special to constructed inventory |
| url | string readOnly: true title: Url |
| variables | string default: title: Variables Inventory variables in JSON or YAML format. |
| verbosity | integer maximum: 2 minimum: 0 title: Verbosity The verbosity level for the related auto-created inventory source, special to constructed inventory |
| name* | string minLength: 1 title: Name |
| cloud | string readOnly: true title: Cloud |
| created | string readOnly: true title: Created |
| credential_type* | integer title: Credential Type Specify the type of credential you want to create. Refer to the documentation for details on each type. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inputs | Inputs{...} |
| kind | string readOnly: true title: Kind |
| kubernetes | string readOnly: true title: Kubernetes |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer title: Organization |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| input_field_name* | string maxLength: 1024 minLength: 1 title: Input field name |
| metadata | Metadata{...} |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| source_credential* | integer title: Source credential |
| summary_fields | string readOnly: true title: Summary fields |
| target_credential* | integer title: Target credential |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| cloud | string readOnly: true title: Cloud |
| created | string readOnly: true title: Created |
| credential_type* | integer title: Credential Type Specify the type of credential you want to create. Refer to the documentation for details on each type. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inputs | Inputs{...} |
| kind | string readOnly: true title: Kind |
| kubernetes | string readOnly: true title: Kubernetes |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer title: Organization Inherit permissions from organization roles. If provided on creation, do not give either user or team. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| team | integer title: Team Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer title: User Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| injectors | Injectors{...} |
| inputs | Inputs{...} |
| kind* | string title: KindEnum: Array [ 12 ] |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| namespace | string minLength: 1 readOnly: true title: Namespace |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| image* | string maxLength: 1024 minLength: 1 title: Image location The full image location, including the container registry, image name, and version tag. |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer title: Organization The organization used to determine access to this execution environment. |
| pull | string default: title: Pull Pull image before running? Array [ 3 ] |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inventory* | integer title: Inventory |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| variables | string default: title: Variables Group variables in JSON or YAML format. |
| children | string readOnly: true title: Children |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inventory* | integer title: Inventory |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| variables | string default: title: Variables Group variables in JSON or YAML format. |
| variables | string default: title: Variables Group variables in JSON or YAML format. |
| ansible_facts_modified | string($date-time) readOnly: true title: Ansible facts modified The date and time ansible_facts was last modified. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| enabled | boolean default: true title: Enabled Is this host online and available for running jobs? |
| has_active_failures | string readOnly: true title: Has active failures |
| has_inventory_sources | string readOnly: true title: Has inventory sources |
| id | integer readOnly: true title: ID |
| instance_id | string default: maxLength: 1024 title: Instance id The value used by the remote inventory source to uniquely identify the host |
| inventory* | integer title: Inventory |
| last_job | string readOnly: true title: Last job |
| last_job_host_summary | integer readOnly: true title: Last job host summary |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| variables | string default: title: Variables Host variables in JSON or YAML format. |
| automated_counter | integer default: 0 title: Automated counter How many times was the host automated |
| deleted | boolean default: false title: Deleted Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption |
| deleted_counter | integer default: 0 title: Deleted counter How many times was the host deleted |
| first_automation | string($date-time) readOnly: true title: First automation When the host was first automated against |
| hostname* | string maxLength: 512 minLength: 1 title: Hostname |
| id | integer readOnly: true title: ID |
| last_automation* | string($date-time) title: Last automation When the host was last automated against |
| last_deleted | string($date-time) title: Last deleted When the host was last deleted |
| url | string readOnly: true title: Url |
| used_in_inventories | integer title: Used in inventories How many inventories contain this host |
| date | string($date) readOnly: true title: Date |
| hosts_added | integer readOnly: true title: Hosts added How many hosts were added in the associated month, consuming more license capacity |
| hosts_deleted | integer readOnly: true title: Hosts deleted How many hosts were deleted in the associated month, freeing the license capacity |
| id | integer readOnly: true title: ID |
| indirectly_managed_hosts | integer readOnly: true title: Indirectly managed hosts Manually entered number indirectly managed hosts for a certain month |
| license_capacity | integer readOnly: true title: License capacity 'License capacity as max. number of unique hosts |
| license_consumed | integer readOnly: true title: License consumed How many unique hosts are consumed from the license |
| variables | string default: title: Variables Host variables in JSON or YAML format. |
| capacity | integer minimum: 0 readOnly: true title: Capacity |
| capacity_adjustment | string($decimal) default: 1.00 title: Capacity adjustment |
| consumed_capacity | string readOnly: true title: Consumed capacity |
| cpu | string($decimal) readOnly: true title: Cpu |
| cpu_capacity | integer readOnly: true title: Cpu capacity |
| created | string readOnly: true title: Created |
| enabled | boolean default: true title: Enabled |
| errors | string minLength: 1 readOnly: true title: Errors Any error details from the last health check. |
| health_check_pending | string readOnly: true title: Health check pending |
| health_check_started | string($date-time) readOnly: true title: Health check started The last time a health check was initiated on this instance. |
| hostname* | string maxLength: 250 minLength: 1 title: Hostname |
| id | integer readOnly: true title: ID |
| ip_address | string minLength: 1 readOnly: true title: Ip address |
| jobs_running | integer readOnly: true title: Jobs running Count of jobs in the running or waiting state that are targeted for this instance |
| jobs_total | integer readOnly: true title: Jobs total Count of all jobs that target this instance |
| last_health_check | string($date-time) readOnly: true title: Last health check Last time a health check was ran on this instance to refresh cpu, memory, and capacity. |
| last_seen | string($date-time) readOnly: true title: Last seen Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. |
| listener_port | integer maximum: 65535 minimum: 0 title: Listener port Port that Receptor will listen for incoming connections on. |
| managed_by_policy | boolean default: true title: Managed by policy |
| mem_capacity | integer readOnly: true title: Mem capacity |
| memory | integer readOnly: true title: Memory Total system memory of this instance in bytes. |
| modified | string readOnly: true title: Modified |
| node_state | string default: installed title: Node state Indicates the current life cycle stage of this instance. Array [ 7 ] |
| node_type | string default: execution title: Node type Role that this node plays in the mesh. Array [ 4 ] |
| peers | [...] |
| peers_from_control_nodes | boolean default: false title: Peers from control nodes If True, control plane cluster nodes should automatically peer to it. |
| percent_capacity_remaining | string readOnly: true title: Percent capacity remaining |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| version | string minLength: 1 readOnly: true title: Version |
| capacity | string readOnly: true title: Capacity |
| consumed_capacity | string readOnly: true title: Consumed capacity |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| id | integer readOnly: true title: ID |
| instances | string readOnly: true title: Instances |
| is_container_group | boolean title: Is container group Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. |
| jobs_running | string readOnly: true title: Jobs running |
| jobs_total | integer readOnly: true title: Jobs total Count of all jobs that target this instance group |
| max_concurrent_jobs | integer default: 0 minimum: 0 title: Max Concurrent Jobs Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. |
| max_forks | integer default: 0 minimum: 0 title: Max Forks Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 250 minLength: 1 title: Name |
| percent_capacity_remaining | string readOnly: true title: Percent capacity remaining |
| pod_spec_override | string default: title: Pod spec override |
| policy_instance_list | [...] |
| policy_instance_minimum | integer default: 0 minimum: 0 title: Policy Instance Minimum Static minimum number of Instances that will be automatically assign to this group when new instances come online. |
| policy_instance_percentage | integer default: 0 maximum: 100 minimum: 0 title: Policy Instance Percentage Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| capacity | integer readOnly: true title: Capacity |
| cpu | string($decimal) readOnly: true title: Cpu |
| cpu_capacity | integer readOnly: true title: Cpu capacity |
| errors | string minLength: 1 readOnly: true title: Errors Any error details from the last health check. |
| hostname | string minLength: 1 readOnly: true title: Hostname |
| ip_address | string minLength: 1 readOnly: true title: Ip address |
| last_health_check | string($date-time) readOnly: true title: Last health check Last time a health check was ran on this instance to refresh cpu, memory, and capacity. |
| mem_capacity | integer readOnly: true title: Mem capacity |
| memory | integer readOnly: true title: Memory Total system memory of this instance in bytes. |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| version | string minLength: 1 readOnly: true title: Version |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| has_active_failures | boolean readOnly: true title: Has active failures This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. |
| has_inventory_sources | boolean readOnly: true title: Has inventory sources This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. |
| host_filter | string title: Host filter Filter that will be applied to the hosts of this inventory. |
| hosts_with_active_failures | integer minimum: 0 readOnly: true title: Hosts with active failures This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. |
| id | integer readOnly: true title: ID |
| inventory_sources_with_failures | integer minimum: 0 readOnly: true title: Inventory sources with failures Number of external inventory sources in this inventory with failures. |
| kind | string default: title: Kind Kind of inventory being represented. Array [ 3 ] |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization* | integer title: Organization Organization containing this inventory. |
| pending_deletion | boolean readOnly: true title: Pending deletion Flag indicating the inventory is being deleted. |
| prevent_instance_group_fallback | boolean default: false title: Prevent instance group fallback If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| total_groups | integer minimum: 0 readOnly: true title: Total groups This field is deprecated and will be removed in a future release. Total number of groups in this inventory. |
| total_hosts | integer minimum: 0 readOnly: true title: Total hosts This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. |
| total_inventory_sources | integer minimum: 0 readOnly: true title: Total inventory sources Total number of external inventory sources configured within this inventory. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| variables | string default: title: Variables Inventory variables in JSON or YAML format. |
| created | string readOnly: true title: Created |
| credential | integer minimum: 1 title: Credential Cloud credential to use for inventory updates. |
| custom_virtualenv | string minLength: 1 readOnly: true title: Custom virtualenv Local absolute file path containing a custom Python virtualenv to use |
| description | string default: title: Description |
| enabled_value | string default: title: Enabled value Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled |
| enabled_var | string default: title: Enabled var Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| host_filter | string default: title: Host filter This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. |
| id | integer readOnly: true title: ID |
| inventory* | integer title: Inventory |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| last_update_failed | boolean readOnly: true title: Last update failed |
| last_updated | string($date-time) readOnly: true title: Last updated |
| limit | string default: title: Limit Enter host, group or pattern match |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| overwrite | boolean default: false title: Overwrite Overwrite local groups and hosts from remote inventory source. |
| overwrite_vars | boolean default: false title: Overwrite vars Overwrite local variables from remote inventory source. |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 1024 title: Scm branch Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. |
| source | string title: SourceEnum: Array [ 12 ] |
| source_path | string default: maxLength: 1024 title: Source path |
| source_project | string title: Source project Project containing inventory file used as source. |
| source_vars | string default: title: Source vars Inventory source variables in YAML or JSON format. |
| status | string readOnly: true title: StatusEnum: Array [ 10 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| update_cache_timeout | integer default: 0 minimum: 0 title: Update cache timeout |
| update_on_launch | boolean default: false title: Update on launch |
| url | string readOnly: true title: Url |
| verbosity | integer default: 1 title: VerbosityEnum: Array [ 3 ] |
| can_update | boolean readOnly: true title: Can update |
| can_cancel | boolean readOnly: true title: Can cancel |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| credential | integer minimum: 1 title: Credential Cloud credential to use for inventory updates. |
| custom_virtualenv | string readOnly: true title: Custom virtualenv |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| enabled_value | string default: title: Enabled value Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled |
| enabled_var | string default: title: Enabled var Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| host_filter | string default: title: Host filter This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. |
| id | integer readOnly: true title: ID |
| instance_group | integer title: Instance group The Instance group the job was run under |
| inventory | integer title: Inventory |
| inventory_source | string readOnly: true title: Inventory source |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| license_error | boolean readOnly: true title: License error |
| limit | string default: title: Limit Enter host, group or pattern match |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| org_host_limit_error | boolean readOnly: true title: Org host limit error |
| overwrite | boolean default: false title: Overwrite Overwrite local groups and hosts from remote inventory source. |
| overwrite_vars | boolean default: false title: Overwrite vars Overwrite local variables from remote inventory source. |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| scm_branch | string default: maxLength: 1024 title: Scm branch Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm |
| source | string title: SourceEnum: Array [ 12 ] |
| source_path | string default: maxLength: 1024 title: Source path |
| source_project | string readOnly: true title: Source project The project used for this job. |
| source_project_update | string title: Source project update Inventory files from this Project Update were used for the inventory update. |
| source_vars | string default: title: Source vars Inventory source variables in YAML or JSON format. |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| verbosity | integer default: 1 title: VerbosityEnum: Array [ 3 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| changed | string readOnly: true title: Changed |
| counter | integer minimum: 0 readOnly: true title: Counter |
| created | string readOnly: true title: Created |
| end_line | integer minimum: 0 readOnly: true title: End line |
| event | string readOnly: true title: Event |
| event_data | Event data{...} |
| event_display | string minLength: 1 readOnly: true title: Event display |
| failed | string readOnly: true title: Failed |
| id | integer readOnly: true title: ID |
| inventory_update | string readOnly: true title: Inventory update |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| start_line | integer minimum: 0 readOnly: true title: Start line |
| stdout | string minLength: 1 readOnly: true title: Stdout |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| verbosity | integer minimum: 0 readOnly: true title: Verbosity |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| credential | integer minimum: 1 title: Credential Cloud credential to use for inventory updates. |
| custom_virtualenv | string readOnly: true title: Custom virtualenv |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| enabled_value | string default: title: Enabled value Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled |
| enabled_var | string default: title: Enabled var Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default) |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| host_filter | string default: title: Host filter This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. |
| id | integer readOnly: true title: ID |
| instance_group | integer title: Instance group The Instance group the job was run under |
| inventory | integer title: Inventory |
| inventory_source | string readOnly: true title: Inventory source |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| license_error | boolean readOnly: true title: License error |
| limit | string default: title: Limit Enter host, group or pattern match |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| org_host_limit_error | boolean readOnly: true title: Org host limit error |
| overwrite | boolean default: false title: Overwrite Overwrite local groups and hosts from remote inventory source. |
| overwrite_vars | boolean default: false title: Overwrite vars Overwrite local variables from remote inventory source. |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 1024 title: Scm branch Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm |
| source | string title: SourceEnum: Array [ 12 ] |
| source_path | string default: maxLength: 1024 title: Source path |
| source_project_update | string title: Source project update Inventory files from this Project Update were used for the inventory update. |
| source_vars | string default: title: Source vars Inventory source variables in YAML or JSON format. |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| verbosity | integer default: 1 title: VerbosityEnum: Array [ 3 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| variables | string default: title: Variables Inventory variables in JSON or YAML format. |
| can_cancel | boolean readOnly: true title: Can cancel |
| can_schedule | string readOnly: true title: Can schedule |
| prompts | string readOnly: true title: Prompts |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| artifacts | string readOnly: true title: Artifacts |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| custom_virtualenv | string readOnly: true title: Custom virtualenv |
| description | string default: title: Description |
| diff_mode | boolean default: false title: Diff mode If enabled, textual changes made to any templated files on the host are shown in the standard output |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| force_handlers | boolean default: false title: Force handlers |
| forks | integer default: 0 minimum: 0 title: Forks |
| host_status_counts | Host status counts{...} |
| id | integer readOnly: true title: ID |
| instance_group | integer title: Instance group The Instance group the job was run under |
| inventory | integer title: Inventory |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_slice_count | integer default: 1 minimum: 0 title: Job slice count If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. |
| job_slice_number | integer default: 0 minimum: 0 title: Job slice number If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. |
| job_tags | string default: title: Job tags |
| job_template | string title: Job template |
| job_type | string default: run title: Job typeEnum: Array [ 3 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string default: title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer readOnly: true title: Organization The organization used to determine access to this unified job. |
| passwords_needed_to_start | string readOnly: true title: Passwords needed to start |
| playbook | string default: maxLength: 1024 title: Playbook |
| playbook_counts | string readOnly: true title: Playbook counts A count of all plays and tasks for the job run. |
| project | string title: Project |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| scm_branch | string default: maxLength: 1024 title: Scm branch Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision from the Project used for this job, if available |
| skip_tags | string default: maxLength: 1024 title: Skip tags |
| start_at_task | string default: maxLength: 1024 title: Start at task |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| use_fact_cache | boolean default: false title: Use fact cache If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. |
| verbosity | integer default: 0 title: VerbosityEnum: Array [ 6 ] |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_guid | string maxLength: 128 title: Webhook guid Unique identifier of the event that triggered this webhook |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| changed | boolean readOnly: true title: Changed |
| counter | integer minimum: 0 readOnly: true title: Counter |
| created | string readOnly: true title: Created |
| end_line | integer minimum: 0 readOnly: true title: End line |
| event* | string title: EventEnum: Array [ 33 ] |
| event_data | Event data{...} |
| event_display | string minLength: 1 readOnly: true title: Event display |
| event_level | integer readOnly: true title: Event level |
| failed | boolean readOnly: true title: Failed |
| host | integer readOnly: true title: Host |
| host_name | string minLength: 1 readOnly: true title: Host name |
| id | integer readOnly: true title: ID |
| job | string readOnly: true title: Job |
| modified | string readOnly: true title: Modified |
| parent_uuid | string minLength: 1 readOnly: true title: Parent uuid |
| play | string minLength: 1 readOnly: true title: Play |
| playbook | string minLength: 1 readOnly: true title: Playbook |
| related | string readOnly: true title: Related |
| role | string minLength: 1 readOnly: true title: Role |
| start_line | integer minimum: 0 readOnly: true title: Start line |
| stdout | string minLength: 1 readOnly: true title: Stdout |
| summary_fields | string readOnly: true title: Summary fields |
| task | string minLength: 1 readOnly: true title: Task |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| verbosity | integer minimum: 0 readOnly: true title: Verbosity |
| changed | integer minimum: 0 readOnly: true title: Changed |
| constructed_host | integer readOnly: true title: Constructed host Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. |
| created | string readOnly: true title: Created |
| dark | integer minimum: 0 readOnly: true title: Dark |
| failed | boolean readOnly: true title: Failed |
| failures | integer minimum: 0 readOnly: true title: Failures |
| host | integer readOnly: true title: Host |
| host_name | string default: minLength: 1 readOnly: true title: Host name |
| id | integer readOnly: true title: ID |
| ignored | integer minimum: 0 readOnly: true title: Ignored |
| job | string readOnly: true title: Job |
| modified | string readOnly: true title: Modified |
| ok | integer minimum: 0 readOnly: true title: Ok |
| processed | integer minimum: 0 readOnly: true title: Processed |
| related | string readOnly: true title: Related |
| rescued | integer minimum: 0 readOnly: true title: Rescued |
| skipped | integer minimum: 0 readOnly: true title: Skipped |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| ask_credential_on_launch | boolean readOnly: true title: Ask credential on launch |
| ask_diff_mode_on_launch | boolean readOnly: true title: Ask diff mode on launch |
| ask_execution_environment_on_launch | boolean readOnly: true title: Ask execution environment on launch |
| ask_forks_on_launch | boolean readOnly: true title: Ask forks on launch |
| ask_instance_groups_on_launch | boolean readOnly: true title: Ask instance groups on launch |
| ask_inventory_on_launch | boolean readOnly: true title: Ask inventory on launch |
| ask_job_slice_count_on_launch | boolean readOnly: true title: Ask job slice count on launch |
| ask_job_type_on_launch | boolean readOnly: true title: Ask job type on launch |
| ask_labels_on_launch | boolean readOnly: true title: Ask labels on launch |
| ask_limit_on_launch | boolean readOnly: true title: Ask limit on launch |
| ask_scm_branch_on_launch | boolean readOnly: true title: Ask scm branch on launch |
| ask_skip_tags_on_launch | boolean readOnly: true title: Ask skip tags on launch |
| ask_tags_on_launch | boolean readOnly: true title: Ask tags on launch |
| ask_timeout_on_launch | boolean readOnly: true title: Ask timeout on launch |
| ask_variables_on_launch | boolean readOnly: true title: Ask variables on launch |
| ask_verbosity_on_launch | boolean readOnly: true title: Ask verbosity on launch |
| can_start_without_user_input | boolean readOnly: true title: Can start without user input |
| credential_needed_to_start | string readOnly: true title: Credential needed to start |
| credential_passwords | string title: Credential passwords |
| credentials | [...] |
| defaults | string readOnly: true title: Defaults |
| diff_mode | boolean title: Diff mode |
| execution_environment | integer title: Execution environment |
| extra_vars | Extra vars{...} |
| forks | integer minimum: 0 title: Forks |
| instance_groups | [...] |
| inventory | integer title: Inventory |
| inventory_needed_to_start | string readOnly: true title: Inventory needed to start |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_template_data | string readOnly: true title: Job template data |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| labels | [...] |
| limit | string title: Limit |
| passwords_needed_to_start | string readOnly: true title: Passwords needed to start |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| survey_enabled | string readOnly: true title: Survey enabled |
| timeout | integer title: Timeout |
| variables_needed_to_start | string readOnly: true title: Variables needed to start |
| verbosity | integer title: VerbosityEnum: Array [ 6 ] |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| artifacts | string readOnly: true title: Artifacts |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| diff_mode | boolean default: false title: Diff mode If enabled, textual changes made to any templated files on the host are shown in the standard output |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| force_handlers | boolean default: false title: Force handlers |
| forks | integer default: 0 minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| instance_group | integer title: Instance group The Instance group the job was run under |
| inventory | integer title: Inventory |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_slice_count | integer default: 1 minimum: 0 title: Job slice count If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. |
| job_slice_number | integer default: 0 minimum: 0 title: Job slice number If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. |
| job_tags | string default: title: Job tags |
| job_template | string title: Job template |
| job_type | string default: run title: Job typeEnum: Array [ 3 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string default: title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer readOnly: true title: Organization The organization used to determine access to this unified job. |
| passwords_needed_to_start | string readOnly: true title: Passwords needed to start |
| playbook | string default: maxLength: 1024 title: Playbook |
| project | string title: Project |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 1024 title: Scm branch Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision from the Project used for this job, if available |
| skip_tags | string default: maxLength: 1024 title: Skip tags |
| start_at_task | string default: maxLength: 1024 title: Start at task |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| use_fact_cache | boolean default: false title: Use fact cache If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. |
| verbosity | integer default: 0 title: VerbosityEnum: Array [ 6 ] |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_guid | string maxLength: 128 title: Webhook guid Unique identifier of the event that triggered this webhook |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| credential_passwords* | string title: Credential passwords |
| hosts | string default: all title: HostsEnum: Array [ 2 ] |
| passwords_needed_to_start | string readOnly: true title: Passwords needed to start |
| retry_counts | string readOnly: true title: Retry counts |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| ask_credential_on_launch | boolean default: false title: Ask credential on launch |
| ask_diff_mode_on_launch | boolean default: false title: Ask diff mode on launch |
| ask_execution_environment_on_launch | boolean default: false title: Ask execution environment on launch |
| ask_forks_on_launch | boolean default: false title: Ask forks on launch |
| ask_instance_groups_on_launch | boolean default: false title: Ask instance groups on launch |
| ask_inventory_on_launch | boolean default: false title: Ask inventory on launch |
| ask_job_slice_count_on_launch | boolean default: false title: Ask job slice count on launch |
| ask_job_type_on_launch | boolean default: false title: Ask job type on launch |
| ask_labels_on_launch | boolean default: false title: Ask labels on launch |
| ask_limit_on_launch | boolean default: false title: Ask limit on launch |
| ask_scm_branch_on_launch | boolean default: false title: Ask scm branch on launch |
| ask_skip_tags_on_launch | boolean default: false title: Ask skip tags on launch |
| ask_tags_on_launch | boolean default: false title: Ask tags on launch |
| ask_timeout_on_launch | boolean default: false title: Ask timeout on launch |
| ask_variables_on_launch | boolean default: false title: Ask variables on launch |
| ask_verbosity_on_launch | boolean default: false title: Ask verbosity on launch |
| become_enabled | boolean default: false title: Become enabled |
| created | string readOnly: true title: Created |
| custom_virtualenv | string minLength: 1 readOnly: true title: Custom virtualenv Local absolute file path containing a custom Python virtualenv to use |
| description | string default: title: Description |
| diff_mode | boolean default: false title: Diff mode If enabled, textual changes made to any templated files on the host are shown in the standard output |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_vars | string default: title: Extra vars |
| force_handlers | boolean default: false title: Force handlers |
| forks | integer default: 0 minimum: 0 title: Forks |
| host_config_key | string default: maxLength: 1024 title: Host config key |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory |
| job_slice_count | integer default: 1 minimum: 0 title: Job slice count The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. |
| job_tags | string default: title: Job tags |
| job_type | string default: run title: Job typeEnum: Array [ 2 ] |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| limit | string default: title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| organization | integer readOnly: true title: Organization The organization used to determine access to this template. |
| playbook | string default: maxLength: 1024 title: Playbook |
| prevent_instance_group_fallback | boolean default: false title: Prevent instance group fallback If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. |
| project | string title: Project |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 1024 title: Scm branch Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. |
| skip_tags | string default: maxLength: 1024 title: Skip tags |
| start_at_task | string default: maxLength: 1024 title: Start at task |
| status | string readOnly: true title: StatusEnum: Array [ 9 ] |
| summary_fields | string readOnly: true title: Summary fields |
| survey_enabled | boolean default: false title: Survey enabled |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| use_fact_cache | boolean default: false title: Use fact cache If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. |
| verbosity | integer default: 0 title: VerbosityEnum: Array [ 6 ] |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| created | string readOnly: true title: Created |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization* | integer title: Organization Organization this label belongs to. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| body | string readOnly: true title: Body Notification body |
| created | string readOnly: true title: Created |
| error | string minLength: 1 readOnly: true title: Error |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| notification_template | integer readOnly: true title: Notification template |
| notification_type* | string title: Notification typeEnum: Array [ 9 ] |
| notifications_sent | integer readOnly: true title: Notifications sent |
| recipients | string minLength: 1 readOnly: true title: Recipients |
| related | string readOnly: true title: Related |
| status | string readOnly: true title: StatusEnum: Array [ 3 ] |
| subject | string minLength: 1 readOnly: true title: Subject |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| messages | Messages{...} |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| notification_configuration | Notification configuration{...} |
| notification_type* | string title: Notification typeEnum: Array [ 9 ] |
| organization* | integer title: Organization |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| authorization_grant_type* | string title: Authorization Grant Type The Grant type the user must use for acquire tokens for this application. Array [ 2 ] |
| client_id | string minLength: 1 readOnly: true title: Client id |
| client_secret | string minLength: 1 readOnly: true title: Client Secret Used for more stringent verification of access to an application when creating a token. |
| client_type* | string title: Client Type Set to Public or Confidential depending on how secure the client device is. Array [ 2 ] |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: Id |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 255 title: Name |
| organization* | integer title: Organization Organization containing this application. |
| redirect_uris | string title: Redirect URIs Allowed URIs list, space separated |
| related | string readOnly: true title: Related |
| skip_authorization | boolean default: false title: Skip Authorization Set True to skip authorization step for completely trusted applications. |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| application | integer title: Application |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| expires | string($date-time) readOnly: true title: Expires |
| id | integer readOnly: true title: Id |
| modified | string readOnly: true title: Modified |
| refresh_token | string readOnly: true title: Refresh token |
| related | string readOnly: true title: Related |
| scope | string default: write title: Scope Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes ['read’, ‘write’]. |
| summary_fields | string readOnly: true title: Summary fields |
| token | string readOnly: true title: Token |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer readOnly: true title: User The user representing the token owner |
| application | integer readOnly: true title: Application |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| expires | string($date-time) readOnly: true title: Expires |
| id | integer readOnly: true title: Id |
| modified | string readOnly: true title: Modified |
| refresh_token | string readOnly: true title: Refresh token |
| related | string readOnly: true title: Related |
| scope | string default: write title: Scope Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes ['read’, ‘write’]. |
| summary_fields | string readOnly: true title: Summary fields |
| token | string readOnly: true title: Token |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer readOnly: true title: User The user representing the token owner |
| created | string readOnly: true title: Created |
| custom_virtualenv | string minLength: 1 readOnly: true title: Custom virtualenv Local absolute file path containing a custom Python virtualenv to use |
| default_environment | integer title: Default environment The default execution environment for jobs run by this organization. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| max_hosts | integer default: 0 minimum: 0 title: Max hosts Maximum number of hosts allowed to be managed by this organization. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| cloud | string readOnly: true title: Cloud |
| created | string readOnly: true title: Created |
| credential_type* | integer title: Credential Type Specify the type of credential you want to create. Refer to the documentation for details on each type. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inputs | Inputs{...} |
| kind | string readOnly: true title: Kind |
| kubernetes | string readOnly: true title: Kubernetes |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization | integer title: Organization Inherit permissions from organization roles. If provided on creation, do not give either user or team. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| allow_override | boolean default: false title: Allow override Allow changing the SCM branch or revision in a job template that uses this project. |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| custom_virtualenv | string minLength: 1 readOnly: true title: Custom virtualenv Local absolute file path containing a custom Python virtualenv to use |
| default_environment | integer title: Default environment The default execution environment for jobs run using this project. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| last_update_failed | boolean readOnly: true title: Last update failed |
| last_updated | string($date-time) readOnly: true title: Last updated |
| local_path | string maxLength: 1024 title: Local path Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| organization | integer title: Organization The organization used to determine access to this template. |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 256 title: SCM Branch Specific branch, tag or commit to checkout. |
| scm_clean | boolean default: false title: Scm clean Discard any local changes before syncing the project. |
| scm_delete_on_update | boolean default: false title: Scm delete on update Delete the project before syncing. |
| scm_refspec | string default: maxLength: 1024 title: SCM refspec For git projects, an additional refspec to fetch. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The last revision fetched by a project update |
| scm_track_submodules | boolean default: false title: Scm track submodules Track submodules latest commits on defined branch. |
| scm_type | string default: title: SCM Type Specifies the source control system used to store the project. Array [ 5 ] |
| scm_update_cache_timeout | integer default: 0 minimum: 0 title: Scm update cache timeout The number of seconds after the last project update ran that a new project update will be launched as a job dependency. |
| scm_update_on_launch | boolean default: false title: Scm update on launch Update the project when a job is launched that uses the project. |
| scm_url | string default: maxLength: 1024 title: SCM URL The location where the project is stored. |
| signature_validation_credential | integer title: Signature validation credential An optional credential used for validating files in the project against unexpected changes. |
| status | string readOnly: true title: StatusEnum: Array [ 11 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| inventory_files | string readOnly: true title: Inventory files Array of inventory files and directories available within this project, not comprehensive. |
| playbooks | string readOnly: true title: Playbooks Array of playbooks available within this project. |
| can_cancel | boolean readOnly: true title: Can cancel |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| host_status_counts | Host status counts{...} |
| id | integer readOnly: true title: ID |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_tags | string default: maxLength: 1024 title: Job tags Parts of the project update playbook that will be run. |
| job_type | string default: check title: Job typeEnum: Array [ 2 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| local_path | string maxLength: 1024 title: Local path Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| playbook_counts | string readOnly: true title: Playbook counts A count of all plays and tasks for the job run. |
| project | string readOnly: true title: Project |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| scm_branch | string default: maxLength: 256 title: SCM Branch Specific branch, tag or commit to checkout. |
| scm_clean | boolean default: false title: Scm clean Discard any local changes before syncing the project. |
| scm_delete_on_update | boolean default: false title: Scm delete on update Delete the project before syncing. |
| scm_refspec | string default: maxLength: 1024 title: SCM refspec For git projects, an additional refspec to fetch. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision discovered by this update for the given project and branch. |
| scm_track_submodules | boolean default: false title: Scm track submodules Track submodules latest commits on defined branch. |
| scm_type | string default: title: SCM Type Specifies the source control system used to store the project. Array [ 5 ] |
| scm_url | string default: maxLength: 1024 title: SCM URL The location where the project is stored. |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| changed | boolean readOnly: true title: Changed |
| counter | integer minimum: 0 readOnly: true title: Counter |
| created | string readOnly: true title: Created |
| end_line | integer minimum: 0 readOnly: true title: End line |
| event* | string title: EventEnum: Array [ 33 ] |
| event_data | string readOnly: true title: Event data |
| event_display | string minLength: 1 readOnly: true title: Event display |
| event_level | integer readOnly: true title: Event level |
| failed | boolean readOnly: true title: Failed |
| host_name | string readOnly: true title: Host name |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| play | string minLength: 1 readOnly: true title: Play |
| playbook | string minLength: 1 readOnly: true title: Playbook |
| project_update | string readOnly: true title: Project update |
| related | string readOnly: true title: Related |
| role | string minLength: 1 readOnly: true title: Role |
| start_line | integer minimum: 0 readOnly: true title: Start line |
| stdout | string readOnly: true title: Stdout |
| summary_fields | string readOnly: true title: Summary fields |
| task | string minLength: 1 readOnly: true title: Task |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| verbosity | integer minimum: 0 readOnly: true title: Verbosity |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| credential | integer title: Credential |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_tags | string default: maxLength: 1024 title: Job tags Parts of the project update playbook that will be run. |
| job_type | string default: check title: Job typeEnum: Array [ 2 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| local_path | string maxLength: 1024 title: Local path Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| project | string readOnly: true title: Project |
| related | string readOnly: true title: Related |
| scm_branch | string default: maxLength: 256 title: SCM Branch Specific branch, tag or commit to checkout. |
| scm_clean | boolean default: false title: Scm clean Discard any local changes before syncing the project. |
| scm_delete_on_update | boolean default: false title: Scm delete on update Delete the project before syncing. |
| scm_refspec | string default: maxLength: 1024 title: SCM refspec For git projects, an additional refspec to fetch. |
| scm_revision | string minLength: 1 readOnly: true title: SCM Revision The SCM Revision discovered by this update for the given project and branch. |
| scm_track_submodules | boolean default: false title: Scm track submodules Track submodules latest commits on defined branch. |
| scm_type | string default: title: SCM Type Specifies the source control system used to store the project. Array [ 5 ] |
| scm_url | string default: maxLength: 1024 title: SCM URL The location where the project is stored. |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) to run before the task is canceled. |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| can_update | boolean readOnly: true title: Can update |
| created | string readOnly: true title: Created |
| string maxLength: 254 title: Email address | |
| external_account | string readOnly: true title: External account Set if the account is managed by an external service |
| first_name | string maxLength: 150 title: First name |
| id | integer readOnly: true title: ID |
| is_superuser | boolean default: false title: Superuser status Designates that this user has all permissions without explicitly assigning them. |
| is_system_auditor | boolean default: false title: Is system auditor |
| last_login | string($date-time) readOnly: true title: Last login |
| last_name | string maxLength: 150 title: Last name |
| ldap_dn | string minLength: 1 readOnly: true title: Ldap dn |
| modified | string readOnly: true title: Modified |
| password | string default: minLength: 1 title: Password Field used to change the password. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| username* | string maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ title: Username Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| description | string readOnly: true title: Description |
| id | integer readOnly: true title: ID |
| name | string readOnly: true title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| description | string readOnly: true title: Description |
| id | integer readOnly: true title: ID |
| name | string readOnly: true title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| diff_mode | boolean title: Diff mode |
| dtend | string($date-time) readOnly: true title: Dtend The last occurrence of the schedule occurs before this time, aftewards the schedule expires. |
| dtstart | string($date-time) readOnly: true title: Dtstart The first occurrence of the schedule occurs on or after this time. |
| enabled | boolean default: true title: Enabled Enables processing of this schedule. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_data | Extra data{...} |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_run | string($date-time) readOnly: true title: Next run The next time that the scheduled action will run. |
| related | string readOnly: true title: Related |
| rrule* | string minLength: 1 title: Rrule A value representing the schedules iCal recurrence rule. |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| timezone | string readOnly: true title: Timezone The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. |
| type | string readOnly: true title: Type |
| unified_job_template* | integer title: Unified job template |
| until | string readOnly: true title: Until The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| rrule* | string minLength: 1 title: Rrule A value representing the schedules iCal recurrence rule. |
| name | string minLength: 1 readOnly: true title: Name |
| slug | string minLength: 1 readOnly: true title: Slug |
| url | string minLength: 1 readOnly: true title: Url |
| ACTIVITY_STREAM_ENABLED* | boolean default: true title: Enable Activity Stream Enable capturing activity for the activity stream. |
| ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC* | boolean default: false title: Enable Activity Stream for Inventory Sync Enable capturing activity for the activity stream when running inventory sync. |
| AD_HOC_COMMANDS | [...] |
| ALLOW_JINJA_IN_EXTRA_VARS* | string default: template title: When can extra variables contain Jinja templates? Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to “template” or "never". Array [ 3 ] |
| ALLOW_METRICS_FOR_ANONYMOUS_USERS | boolean default: false title: Allow anonymous users to poll metrics If true, anonymous users are allowed to poll metrics. |
| ALLOW_OAUTH2_FOR_EXTERNAL_USERS | boolean default: false title: Allow External Users to Create OAuth2 Tokens For security reasons, users from external auth providers (LDAP, SAML, SSO, Radius, and others) are not allowed to create OAuth2 tokens. To change this behavior, enable this setting. Existing tokens will not be deleted when this setting is toggled off. |
| ANSIBLE_FACT_CACHE_TIMEOUT | integer default: 0 minimum: 0 title: Per-Host Ansible Fact Cache Timeout Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed. |
| API_400_ERROR_LOG_FORMAT | string default: status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr} minLength: 1 title: Log Format For API 4XX Errors The format of logged messages when an API 4XX error occurs, the following variables will be substituted: |
| AUTHENTICATION_BACKENDS | [...] |
| AUTH_BASIC_ENABLED* | boolean default: true title: Enable HTTP Basic Auth Enable HTTP Basic Auth for the API Browser. |
| AUTH_LDAP_1_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_1_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_1_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_1_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_1_GROUP_SEARCH | [...] |
| AUTH_LDAP_1_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_1_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_1_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_1_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_1_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_1_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_1_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_1_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_1_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_1_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_1_USER_SEARCH | [...] |
| AUTH_LDAP_2_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_2_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_2_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_2_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_2_GROUP_SEARCH | [...] |
| AUTH_LDAP_2_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_2_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_2_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_2_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_2_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_2_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_2_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_2_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_2_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_2_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_2_USER_SEARCH | [...] |
| AUTH_LDAP_3_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_3_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_3_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_3_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_3_GROUP_SEARCH | [...] |
| AUTH_LDAP_3_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_3_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_3_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_3_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_3_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_3_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_3_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_3_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_3_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_3_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_3_USER_SEARCH | [...] |
| AUTH_LDAP_4_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_4_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_4_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_4_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_4_GROUP_SEARCH | [...] |
| AUTH_LDAP_4_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_4_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_4_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_4_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_4_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_4_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_4_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_4_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_4_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_4_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_4_USER_SEARCH | [...] |
| AUTH_LDAP_5_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_5_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_5_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_5_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_5_GROUP_SEARCH | [...] |
| AUTH_LDAP_5_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_5_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_5_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_5_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_5_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_5_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_5_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_5_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_5_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_5_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_5_USER_SEARCH | [...] |
| AUTH_LDAP_BIND_DN | string default: title: LDAP Bind DN DN (Distinguished Name) of user to bind for all search queries. This is the system user account we will use to login to query LDAP for other user information. Refer to the documentation for example syntax. |
| AUTH_LDAP_BIND_PASSWORD | string default: title: LDAP Bind Password Password used to bind LDAP user account. |
| AUTH_LDAP_CONNECTION_OPTIONS | LDAP Connection Options{...} |
| AUTH_LDAP_DENY_GROUP | string title: LDAP Deny Group Group DN denied from login. If specified, user will not be allowed to login if a member of this group. Only one deny group is supported. |
| AUTH_LDAP_GROUP_SEARCH | [...] |
| AUTH_LDAP_GROUP_TYPE | string default: MemberDNGroupType title: LDAP Group Type The group type may need to be changed based on the type of the LDAP server. Values are listed at: https://django-auth-ldap.readthedocs.io/en/stable/groups.html#types-of-groups Array [ 12 ] |
| AUTH_LDAP_GROUP_TYPE_PARAMS | LDAP Group Type Parameters{...} |
| AUTH_LDAP_ORGANIZATION_MAP | LDAP Organization Map{...} |
| AUTH_LDAP_REQUIRE_GROUP | string title: LDAP Require Group Group DN required to login. If specified, user must be a member of this group to login via LDAP. If not set, everyone in LDAP that matches the user search will be able to login to the service. Only one require group is supported. |
| AUTH_LDAP_SERVER_URI | string default: title: LDAP Server URI URI to connect to LDAP server, such as “ldap://ldap.example.com:389” (non-SSL) or “ldaps://ldap.example.com:636” (SSL). Multiple LDAP servers may be specified by separating with spaces or commas. LDAP authentication is disabled if this parameter is empty. |
| AUTH_LDAP_START_TLS | boolean default: false title: LDAP Start TLS Whether to enable TLS when the LDAP connection is not using SSL. |
| AUTH_LDAP_TEAM_MAP | LDAP Team Map{...} |
| AUTH_LDAP_USER_ATTR_MAP | LDAP User Attribute Map{...} |
| AUTH_LDAP_USER_DN_TEMPLATE | string title: LDAP User DN Template Alternative to user search, if user DNs are all of the same format. This approach is more efficient for user lookups than searching if it is usable in your organizational environment. If this setting has a value it will be used instead of AUTH_LDAP_USER_SEARCH. |
| AUTH_LDAP_USER_FLAGS_BY_GROUP | LDAP User Flags By Group{...} |
| AUTH_LDAP_USER_SEARCH | [...] |
| AUTOMATION_ANALYTICS_GATHER_INTERVAL | integer default: 14400 minimum: 1800 title: Automation Analytics Gather Interval Interval (in seconds) between data gathering. |
| AUTOMATION_ANALYTICS_LAST_ENTRIES | string default: title: Last gathered entries from the data collection service of Automation Analytics |
| AUTOMATION_ANALYTICS_LAST_GATHER* | string($date-time) title: Last gather date for Automation Analytics. |
| AUTOMATION_ANALYTICS_URL | string default: https://example.com minLength: 1 title: Automation Analytics upload URL This setting is used to to configure the upload URL for data collection for Automation Analytics. |
| AWX_ANSIBLE_CALLBACK_PLUGINS | [...] |
| AWX_CLEANUP_PATHS | boolean default: true title: Enable or Disable tmp dir cleanup Enable or Disable TMP Dir cleanup |
| AWX_COLLECTIONS_ENABLED | boolean default: true title: Enable Collection(s) Download Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects. |
| AWX_ISOLATION_BASE_PATH* | string default: /tmp minLength: 1 title: Job execution path The directory in which the service will create new temporary directories for job execution and isolation (such as credential files). |
| AWX_ISOLATION_SHOW_PATHS | [...] |
| AWX_MOUNT_ISOLATED_PATHS_ON_K8S | boolean default: false title: Expose host paths for Container Groups Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. |
| AWX_REQUEST_PROFILE | boolean default: false title: Debug Web Requests Debug web request python timing |
| AWX_ROLES_ENABLED | boolean default: true title: Enable Role Download Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects. |
| AWX_RUNNER_KEEPALIVE_SECONDS* | integer default: 0 title: K8S Ansible Runner Keep-Alive Message Interval Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open. |
| AWX_SHOW_PLAYBOOK_LINKS | boolean default: false title: Follow symlinks Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself. |
| AWX_TASK_ENV | Extra Environment Variables{...} |
| BULK_HOST_MAX_CREATE | integer default: 100 title: Max number of hosts to allow to be created in a single bulk action Max number of hosts to allow to be created in a single bulk action |
| BULK_JOB_MAX_LAUNCH | integer default: 100 title: Max jobs to allow bulk jobs to launch Max jobs to allow bulk jobs to launch |
| CLEANUP_HOST_METRICS_LAST_TS* | string($date-time) title: Last cleanup date for HostMetrics |
| CSRF_TRUSTED_ORIGINS | [...] |
| CUSTOM_LOGIN_INFO | string default: title: Custom Login Info If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported. |
| CUSTOM_LOGO | string default: title: Custom Logo To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported. |
| CUSTOM_VENV_PATHS | [...] |
| DEFAULT_CONTAINER_RUN_OPTIONS | [...] |
| DEFAULT_CONTROL_PLANE_QUEUE_NAME | string default: controlplane minLength: 1 readOnly: true title: The instance group where control plane tasks run |
| DEFAULT_EXECUTION_ENVIRONMENT | integer title: Global default execution environment The Execution Environment to be used when one has not been configured for a job template. |
| DEFAULT_EXECUTION_QUEUE_NAME | string default: default minLength: 1 readOnly: true title: The instance group where user jobs run (currently only on non-VM installs) |
| DEFAULT_INVENTORY_UPDATE_TIMEOUT | integer default: 0 minimum: 0 title: Default Inventory Update Timeout Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this. |
| DEFAULT_JOB_IDLE_TIMEOUT | integer default: 0 minimum: 0 title: Default Job Idle Timeout If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed. |
| DEFAULT_JOB_TIMEOUT | integer default: 0 minimum: 0 title: Default Job Timeout Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this. |
| DEFAULT_PROJECT_UPDATE_TIMEOUT | integer default: 0 minimum: 0 title: Default Project Update Timeout Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this. |
| DISABLE_LOCAL_AUTH* | boolean default: false title: Disable the built-in authentication system Controls whether users are prevented from using the built-in authentication system. You probably want to do this if you are using an LDAP or SAML integration. |
| EVENT_STDOUT_MAX_BYTES_DISPLAY* | integer default: 1024 minimum: 0 title: Job Event Standard Output Maximum Display Size Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. |
| GALAXY_IGNORE_CERTS | boolean default: false title: Ignore Ansible Galaxy SSL Certificate Verification If set to true, certificate validation will not be done when installing content from any Galaxy server. |
| GALAXY_TASK_ENV* | Environment Variables for Galaxy Commands{...} |
| HOST_METRIC_SUMMARY_TASK_LAST_TS* | string($date-time) title: Last computing date of HostMetricSummaryMonthly |
| INSIGHTS_TRACKING_STATE | boolean default: false title: Gather data for Automation Analytics Enables the service to gather data on automation and send it to Automation Analytics. |
| INSTALL_UUID | string default: 00000000-0000-0000-0000-000000000000 minLength: 1 readOnly: true title: Unique identifier for an installation |
| IS_K8S | boolean default: false readOnly: true title: Is k8s Indicates whether the instance is part of a kubernetes-based deployment. |
| LICENSE | License{...} |
| LOCAL_PASSWORD_MIN_DIGITS | integer default: 0 minimum: 0 title: Minimum number of digit characters in local password Minimum number of digit characters required in a local password. 0 means no minimum |
| LOCAL_PASSWORD_MIN_LENGTH | integer default: 0 minimum: 0 title: Minimum number of characters in local password Minimum number of characters required in a local password. 0 means no minimum |
| LOCAL_PASSWORD_MIN_SPECIAL | integer default: 0 minimum: 0 title: Minimum number of special characters in local password Minimum number of special characters required in a local password. 0 means no minimum |
| LOCAL_PASSWORD_MIN_UPPER | integer default: 0 minimum: 0 title: Minimum number of uppercase characters in local password Minimum number of uppercase characters required in a local password. 0 means no minimum |
| LOGIN_REDIRECT_OVERRIDE | string default: title: Login redirect override URL URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page. |
| LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB | integer default: 1 minimum: 1 title: Maximum disk persistence for rsyslogd action queuing (in GB) Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH. |
| LOG_AGGREGATOR_ACTION_QUEUE_SIZE | integer default: 131072 minimum: 1 title: Maximum number of messages that can be stored in the log action queue Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5). |
| LOG_AGGREGATOR_ENABLED | boolean default: false title: Enable External Logging Enable sending logs to external log aggregator. |
| LOG_AGGREGATOR_HOST | string minLength: 1 title: Logging Aggregator Hostname/IP where external logs will be sent to. |
| LOG_AGGREGATOR_INDIVIDUAL_FACTS | boolean default: false title: Log System Tracking Facts Individually If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing. |
| LOG_AGGREGATOR_LEVEL | string default: INFO title: Logging Aggregator Level Threshold Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting) Array [ 5 ] |
| LOG_AGGREGATOR_LOGGERS | [...] |
| LOG_AGGREGATOR_MAX_DISK_USAGE_PATH | string default: /var/lib/awx minLength: 1 title: File system location for rsyslogd disk persistence Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting. |
| LOG_AGGREGATOR_PASSWORD | string default: title: Logging Aggregator Password/Token Password or authentication token for external log aggregator (if required; HTTP/s only). |
| LOG_AGGREGATOR_PORT | integer title: Logging Aggregator Port Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator). |
| LOG_AGGREGATOR_PROTOCOL | string default: https title: Logging Aggregator Protocol Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname. Array [ 3 ] |
| LOG_AGGREGATOR_RSYSLOGD_DEBUG | boolean default: false title: Enable rsyslogd debugging Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation. |
| LOG_AGGREGATOR_TCP_TIMEOUT | integer default: 5 title: TCP Connection Timeout Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols. |
| LOG_AGGREGATOR_TOWER_UUID | string default: title: Cluster-wide unique identifier. Useful to uniquely identify instances. |
| LOG_AGGREGATOR_TYPE | string title: Logging Aggregator Type Format messages for the chosen log aggregator. Array [ 5 ] |
| LOG_AGGREGATOR_USERNAME | string default: title: Logging Aggregator Username Username for external log aggregator (if required; HTTP/s only). |
| LOG_AGGREGATOR_VERIFY_CERT | boolean default: true title: Enable/disable HTTPS certificate verification Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is "https". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection. |
| MANAGE_ORGANIZATION_AUTH* | boolean default: true title: Organization Admins Can Manage Users and Teams Controls whether any Organization Admin has the privileges to create and manage users and teams. You may want to disable this ability if you are using an LDAP or SAML integration. |
| MAX_FORKS | integer default: 200 title: Maximum number of forks per job Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied. |
| MAX_UI_JOB_EVENTS* | integer default: 4000 minimum: 100 title: Max Job Events Retrieved by UI Maximum number of job events for the UI to retrieve within a single request. |
| MAX_WEBSOCKET_EVENT_RATE | integer default: 30 minimum: 0 title: Job Event Maximum Websocket Messages Per Second Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit. |
| OAUTH2_PROVIDER | OAuth 2 Timeout Settings{...} |
| ORG_ADMINS_CAN_SEE_ALL_USERS* | boolean default: true title: All Users Visible to Organization Admins Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization. |
| PENDO_TRACKING_STATE | string default: off readOnly: true title: User Analytics Tracking State Enable or Disable User Analytics Tracking. Array [ 3 ] |
| PROJECT_UPDATE_VVV* | boolean default: false title: Run Project Updates With Higher Verbosity Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates. |
| PROXY_IP_ALLOWED_LIST* | [...] |
| RADIUS_PORT | integer default: 1812 maximum: 65535 minimum: 1 title: RADIUS Port Port of RADIUS server. |
| RADIUS_SECRET | string default: title: RADIUS Secret Shared secret for authenticating to RADIUS server. |
| RADIUS_SERVER | string default: title: RADIUS Server Hostname/IP of RADIUS server. RADIUS authentication is disabled if this setting is empty. |
| RECEPTOR_RELEASE_WORK | boolean default: true title: Release Receptor Work Release receptor work |
| REDHAT_PASSWORD | string default: title: Red Hat customer password This password is used to send data to Automation Analytics |
| REDHAT_USERNAME | string default: title: Red Hat customer username This username is used to send data to Automation Analytics |
| REMOTE_HOST_HEADERS* | [...] |
| SAML_AUTO_CREATE_OBJECTS | boolean default: true title: Automatically Create Organizations and Teams on SAML Login When enabled (the default), mapped Organizations and Teams will be created automatically on successful SAML login. |
| SCHEDULE_MAX_JOBS* | integer default: 10 minimum: 1 title: Maximum Scheduled Jobs Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created. |
| SESSIONS_PER_USER* | integer default: -1 minimum: -1 title: Maximum number of simultaneous logged in sessions Maximum number of simultaneous logged in sessions a user may have. To disable enter -1. |
| SESSION_COOKIE_AGE* | integer default: 1800 maximum: 30000000000 minimum: 60 title: Idle Time Force Log Out Number of seconds that a user is inactive before they will need to login again. |
| SOCIAL_AUTH_AZUREAD_OAUTH2_CALLBACK_URL | string default: https://towerhost/sso/complete/azuread-oauth2/ minLength: 1 readOnly: true title: Azure AD OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_AZUREAD_OAUTH2_KEY | string default: title: Azure AD OAuth2 Key The OAuth2 key (Client ID) from your Azure AD application. |
| SOCIAL_AUTH_AZUREAD_OAUTH2_ORGANIZATION_MAP | Azure AD OAuth2 Organization Map{...} |
| SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET | string default: title: Azure AD OAuth2 Secret The OAuth2 secret (Client Secret) from your Azure AD application. |
| SOCIAL_AUTH_AZUREAD_OAUTH2_TEAM_MAP | Azure AD OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_CALLBACK_URL | string default: https://towerhost/sso/complete/github/ minLength: 1 readOnly: true title: GitHub OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL | string default: title: GitHub Enterprise API URL The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_CALLBACK_URL | string default: https://towerhost/sso/complete/github-enterprise/ minLength: 1 readOnly: true title: GitHub Enterprise OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY | string default: title: GitHub Enterprise OAuth2 Key The OAuth2 key (Client ID) from your GitHub Enterprise developer application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORGANIZATION_MAP | GitHub Enterprise OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_API_URL | string default: title: GitHub Enterprise Organization API URL The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_CALLBACK_URL | string default: https://towerhost/sso/complete/github-enterprise-org/ minLength: 1 readOnly: true title: GitHub Enterprise Organization OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY | string default: title: GitHub Enterprise Organization OAuth2 Key The OAuth2 key (Client ID) from your GitHub Enterprise organization application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME | string default: title: GitHub Enterprise Organization Name The name of your GitHub Enterprise organization, as used in your organization’s URL: https://github.com//. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_ORGANIZATION_MAP | GitHub Enterprise Organization OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_SECRET | string default: title: GitHub Enterprise Organization OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_TEAM_MAP | GitHub Enterprise Organization OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_URL | string default: title: GitHub Enterprise Organization URL The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET | string default: title: GitHub Enterprise OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub Enterprise developer application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_API_URL | string default: title: GitHub Enterprise Team API URL The API URL for your GitHub Enterprise instance, e.g.: http(s)://hostname/api/v3/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_CALLBACK_URL | string default: https://towerhost/sso/complete/github-enterprise-team/ minLength: 1 readOnly: true title: GitHub Enterprise Team OAuth2 Callback URL Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID | string default: title: GitHub Enterprise Team ID Find the numeric team ID using the Github Enterprise API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY | string default: title: GitHub Enterprise Team OAuth2 Key The OAuth2 key (Client ID) from your GitHub Enterprise organization application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_MAP | GitHub Enterprise OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ORGANIZATION_MAP | GitHub Enterprise Team OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_SECRET | string default: title: GitHub Enterprise Team OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub Enterprise organization application. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_TEAM_MAP | GitHub Enterprise Team OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_URL | string default: title: GitHub Enterprise Team URL The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_ENTERPRISE_URL | string default: title: GitHub Enterprise URL The URL for your Github Enterprise instance, e.g.: http(s)://hostname/. Refer to Github Enterprise documentation for more details. |
| SOCIAL_AUTH_GITHUB_KEY | string default: title: GitHub OAuth2 Key The OAuth2 key (Client ID) from your GitHub developer application. |
| SOCIAL_AUTH_GITHUB_ORGANIZATION_MAP | GitHub OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_ORG_CALLBACK_URL | string default: https://towerhost/sso/complete/github-org/ minLength: 1 readOnly: true title: GitHub Organization OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_GITHUB_ORG_KEY | string default: title: GitHub Organization OAuth2 Key The OAuth2 key (Client ID) from your GitHub organization application. |
| SOCIAL_AUTH_GITHUB_ORG_NAME | string default: title: GitHub Organization Name The name of your GitHub organization, as used in your organization’s URL: https://github.com//. |
| SOCIAL_AUTH_GITHUB_ORG_ORGANIZATION_MAP | GitHub Organization OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_ORG_SECRET | string default: title: GitHub Organization OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub organization application. |
| SOCIAL_AUTH_GITHUB_ORG_TEAM_MAP | GitHub Organization OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_SECRET | string default: title: GitHub OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub developer application. |
| SOCIAL_AUTH_GITHUB_TEAM_CALLBACK_URL | string default: https://towerhost/sso/complete/github-team/ minLength: 1 readOnly: true title: GitHub Team OAuth2 Callback URL Create an organization-owned application at https://github.com/organizations//settings/applications and obtain an OAuth2 key (Client ID) and secret (Client Secret). Provide this URL as the callback URL for your application. |
| SOCIAL_AUTH_GITHUB_TEAM_ID | string default: title: GitHub Team ID Find the numeric team ID using the Github API: http://fabian-kostadinov.github.io/2015/01/16/how-to-find-a-github-team-id/. |
| SOCIAL_AUTH_GITHUB_TEAM_KEY | string default: title: GitHub Team OAuth2 Key The OAuth2 key (Client ID) from your GitHub organization application. |
| SOCIAL_AUTH_GITHUB_TEAM_MAP | GitHub OAuth2 Team Map{...} |
| SOCIAL_AUTH_GITHUB_TEAM_ORGANIZATION_MAP | GitHub Team OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GITHUB_TEAM_SECRET | string default: title: GitHub Team OAuth2 Secret The OAuth2 secret (Client Secret) from your GitHub organization application. |
| SOCIAL_AUTH_GITHUB_TEAM_TEAM_MAP | GitHub Team OAuth2 Team Map{...} |
| SOCIAL_AUTH_GOOGLE_OAUTH2_AUTH_EXTRA_ARGUMENTS | Google OAuth2 Extra Arguments{...} |
| SOCIAL_AUTH_GOOGLE_OAUTH2_CALLBACK_URL | string default: https://towerhost/sso/complete/google-oauth2/ minLength: 1 readOnly: true title: Google OAuth2 Callback URL Provide this URL as the callback URL for your application as part of your registration process. Refer to the documentation for more detail. |
| SOCIAL_AUTH_GOOGLE_OAUTH2_KEY | string default: title: Google OAuth2 Key The OAuth2 key from your web application. |
| SOCIAL_AUTH_GOOGLE_OAUTH2_ORGANIZATION_MAP | Google OAuth2 Organization Map{...} |
| SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET | string default: title: Google OAuth2 Secret The OAuth2 secret from your web application. |
| SOCIAL_AUTH_GOOGLE_OAUTH2_TEAM_MAP | Google OAuth2 Team Map{...} |
| SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS | [...] |
| SOCIAL_AUTH_OIDC_KEY | string minLength: 1 title: OIDC Key The OIDC key (Client ID) from your IDP. |
| SOCIAL_AUTH_OIDC_OIDC_ENDPOINT | string default: title: OIDC Provider URL The URL for your OIDC provider including the path up to /.well-known/openid-configuration |
| SOCIAL_AUTH_OIDC_SECRET | string default: title: OIDC Secret The OIDC secret (Client Secret) from your IDP. |
| SOCIAL_AUTH_OIDC_VERIFY_SSL | boolean default: true title: Verify OIDC Provider Certificate Verify the OIDC provider ssl certificate. |
| SOCIAL_AUTH_ORGANIZATION_MAP | Social Auth Organization Map{...} |
| SOCIAL_AUTH_SAML_CALLBACK_URL | string default: https://towerhost/sso/complete/saml/ minLength: 1 readOnly: true title: SAML Assertion Consumer Service (ACS) URL Register the service as a service provider (SP) with each identity provider (IdP) you have configured. Provide your SP Entity ID and this ACS URL for your application. |
| SOCIAL_AUTH_SAML_ENABLED_IDPS | SAML Enabled Identity Providers{...} |
| SOCIAL_AUTH_SAML_EXTRA_DATA | [...] |
| SOCIAL_AUTH_SAML_METADATA_URL | string default: https://towerhost/sso/metadata/saml/ minLength: 1 readOnly: true title: SAML Service Provider Metadata URL If your identity provider (IdP) allows uploading an XML metadata file, you can download one from this URL. |
| SOCIAL_AUTH_SAML_ORGANIZATION_ATTR | SAML Organization Attribute Mapping{...} |
| SOCIAL_AUTH_SAML_ORGANIZATION_MAP | SAML Organization Map{...} |
| SOCIAL_AUTH_SAML_ORG_INFO* | SAML Service Provider Organization Info{...} |
| SOCIAL_AUTH_SAML_SECURITY_CONFIG | SAML Security Config{...} |
| SOCIAL_AUTH_SAML_SP_ENTITY_ID | string default: title: SAML Service Provider Entity ID The application-defined unique identifier used as the audience of the SAML service provider (SP) configuration. This is usually the URL for the service. |
| SOCIAL_AUTH_SAML_SP_EXTRA | SAML Service Provider extra configuration data{...} |
| SOCIAL_AUTH_SAML_SP_PRIVATE_KEY* | string default: title: SAML Service Provider Private Key Create a keypair to use as a service provider (SP) and include the private key content here. |
| SOCIAL_AUTH_SAML_SP_PUBLIC_CERT* | string default: title: SAML Service Provider Public Certificate Create a keypair to use as a service provider (SP) and include the certificate content here. |
| SOCIAL_AUTH_SAML_SUPPORT_CONTACT* | SAML Service Provider Support Contact{...} |
| SOCIAL_AUTH_SAML_TEAM_ATTR | SAML Team Attribute Mapping{...} |
| SOCIAL_AUTH_SAML_TEAM_MAP | SAML Team Map{...} |
| SOCIAL_AUTH_SAML_TECHNICAL_CONTACT* | SAML Service Provider Technical Contact{...} |
| SOCIAL_AUTH_SAML_USER_FLAGS_BY_ATTR | SAML User Flags Attribute Mapping{...} |
| SOCIAL_AUTH_TEAM_MAP | Social Auth Team Map{...} |
| SOCIAL_AUTH_USERNAME_IS_FULL_EMAIL | boolean default: false title: Use Email address for usernames Enabling this setting will tell social auth to use the full Email as username instead of the full name |
| SOCIAL_AUTH_USER_FIELDS | [...] |
| STDOUT_MAX_BYTES_DISPLAY* | integer default: 1048576 minimum: 0 title: Standard Output Maximum Display Size Maximum Size of Standard Output in bytes to display before requiring the output be downloaded. |
| SUBSCRIPTIONS_PASSWORD | string default: title: Red Hat or Satellite password This password is used to retrieve subscription and content information |
| SUBSCRIPTIONS_USERNAME | string default: title: Red Hat or Satellite username This username is used to retrieve subscription and content information |
| SUBSCRIPTION_USAGE_MODEL | string default: title: Defines subscription usage model and shows Host MetricsEnum: Array [ 2 ] |
| TACACSPLUS_AUTH_PROTOCOL | string default: ascii title: TACACS+ Authentication Protocol Choose the authentication protocol used by TACACS+ client. Array [ 2 ] |
| TACACSPLUS_HOST | string default: title: TACACS+ Server Hostname of TACACS+ server. |
| TACACSPLUS_PORT | integer default: 49 maximum: 65535 minimum: 1 title: TACACS+ Port Port number of TACACS+ server. |
| TACACSPLUS_REM_ADDR | boolean default: false title: TACACS+ client address sending enabled Enable the client address sending by TACACS+ client. |
| TACACSPLUS_SECRET | string default: title: TACACS+ Secret Shared secret for authenticating to TACACS+ server. |
| TACACSPLUS_SESSION_TIMEOUT | integer default: 5 minimum: 0 title: TACACS+ Auth Session Timeout TACACS+ session timeout value in seconds, 0 disables timeout. |
| TOWER_URL_BASE* | string default: https://towerhost minLength: 1 title: Base URL of the service This setting is used by services like notifications to render a valid url to the service. |
| UI_LIVE_UPDATES_ENABLED* | boolean default: true title: Enable Live Updates in the UI If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details. |
| UI_NEXT | boolean default: true title: Enable Preview of New User Interface Enable preview of new user interface. |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_type | string default: title: Job typeEnum: Array [ 4 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| result_stdout | string readOnly: true title: Result stdout |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| system_job_template | string title: System job template |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| can_cancel | boolean readOnly: true title: Can cancel |
| changed | string readOnly: true title: Changed |
| counter | integer minimum: 0 readOnly: true title: Counter |
| created | string readOnly: true title: Created |
| end_line | integer minimum: 0 readOnly: true title: End line |
| event | string readOnly: true title: Event |
| event_data | Event data{...} |
| event_display | string minLength: 1 readOnly: true title: Event display |
| failed | string readOnly: true title: Failed |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| start_line | integer minimum: 0 readOnly: true title: Start line |
| stdout | string minLength: 1 readOnly: true title: Stdout |
| summary_fields | string readOnly: true title: Summary fields |
| system_job | string readOnly: true title: System job |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| uuid | string minLength: 1 readOnly: true title: Uuid |
| verbosity | integer minimum: 0 readOnly: true title: Verbosity |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_type | string default: title: Job typeEnum: Array [ 4 ] |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| result_stdout | string readOnly: true title: Result stdout |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| system_job_template | string title: System job template |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| id | integer readOnly: true title: ID |
| job_type | string default: title: Job typeEnum: Array [ 4 ] |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| related | string readOnly: true title: Related |
| status | string readOnly: true title: StatusEnum: Array [ 13 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| organization* | integer title: Organization |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| cloud | string readOnly: true title: Cloud |
| created | string readOnly: true title: Created |
| credential_type* | integer title: Credential Type Specify the type of credential you want to create. Refer to the documentation for details on each type. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inputs | Inputs{...} |
| kind | string readOnly: true title: Kind |
| kubernetes | string readOnly: true title: Kubernetes |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| team | integer title: Team Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| controller_node | string minLength: 1 readOnly: true title: Controller node The instance that managed the execution environment. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| execution_node | string minLength: 1 readOnly: true title: Execution node The node the job executed on. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| result_stdout | string readOnly: true title: Result stdout |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| id | integer readOnly: true title: ID |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| related | string readOnly: true title: Related |
| status | string readOnly: true title: StatusEnum: Array [ 13 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| created | string readOnly: true title: Created |
| string maxLength: 254 title: Email address | |
| external_account | string readOnly: true title: External account Set if the account is managed by an external service |
| first_name | string maxLength: 150 title: First name |
| id | integer readOnly: true title: ID |
| is_superuser | boolean default: false title: Superuser status Designates that this user has all permissions without explicitly assigning them. |
| is_system_auditor | boolean default: false title: Is system auditor |
| last_login | string($date-time) readOnly: true title: Last login |
| last_name | string maxLength: 150 title: Last name |
| ldap_dn | string minLength: 1 readOnly: true title: Ldap dn |
| modified | string readOnly: true title: Modified |
| password | string default: minLength: 1 title: Password Field used to change the password. |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| username* | string maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ title: Username Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| application* | integer title: Application |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| expires | string($date-time) readOnly: true title: Expires |
| id | integer readOnly: true title: Id |
| modified | string readOnly: true title: Modified |
| refresh_token | string readOnly: true title: Refresh token |
| related | string readOnly: true title: Related |
| scope | string default: write title: Scope Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes ['read’, ‘write’]. |
| summary_fields | string readOnly: true title: Summary fields |
| token | string readOnly: true title: Token |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer readOnly: true title: User The user representing the token owner |
| cloud | string readOnly: true title: Cloud |
| created | string readOnly: true title: Created |
| credential_type* | integer title: Credential Type Specify the type of credential you want to create. Refer to the documentation for details on each type. |
| description | string default: title: Description |
| id | integer readOnly: true title: ID |
| inputs | Inputs{...} |
| kind | string readOnly: true title: Kind |
| kubernetes | string readOnly: true title: Kubernetes |
| managed | string readOnly: true title: Managed |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer title: User Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation. |
| application | integer readOnly: true title: Application |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| expires | string($date-time) readOnly: true title: Expires |
| id | integer readOnly: true title: Id |
| modified | string readOnly: true title: Modified |
| refresh_token | string readOnly: true title: Refresh token |
| related | string readOnly: true title: Related |
| scope | string default: write title: Scope Allowed scopes, further restricts user’s permissions. Must be a simple space-separated string with allowed scopes ['read’, ‘write’]. |
| summary_fields | string readOnly: true title: Summary fields |
| token | string readOnly: true title: Token |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| user | integer readOnly: true title: User The user representing the token owner |
| approval_expiration | string readOnly: true title: Approval expiration |
| can_approve_or_deny | string readOnly: true title: Can approve or deny |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| event_processing_finished | boolean readOnly: true title: Event processing finished Indicates whether all of the events generated by this unified job have been saved to the database. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timed_out | string readOnly: true title: Timed out |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| approval_expiration | string readOnly: true title: Approval expiration |
| can_approve_or_deny | string readOnly: true title: Can approve or deny |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timed_out | string readOnly: true title: Timed out |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| id | integer readOnly: true title: ID |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| related | string readOnly: true title: Related |
| status | string readOnly: true title: StatusEnum: Array [ 13 ] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) before the approval node expires and fails. |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| is_sliced_job | boolean default: false title: Is sliced job |
| job_args | string minLength: 1 readOnly: true title: Job args |
| job_cwd | string minLength: 1 readOnly: true title: Job cwd |
| job_env | job_env{...} |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_tags | string title: Job tags |
| job_template | string title: Job template If automatically created for a sliced job run, the job template the workflow job was created from. |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| result_traceback | string minLength: 1 readOnly: true title: Result traceback |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_guid | string maxLength: 128 title: Webhook guid Unique identifier of the event that triggered this webhook |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| workflow_job_template | string title: Workflow job template |
| can_cancel | boolean readOnly: true title: Can cancel |
| ask_inventory_on_launch | boolean readOnly: true title: Ask inventory on launch |
| ask_labels_on_launch | boolean readOnly: true title: Ask labels on launch |
| ask_limit_on_launch | boolean readOnly: true title: Ask limit on launch |
| ask_scm_branch_on_launch | boolean readOnly: true title: Ask scm branch on launch |
| ask_skip_tags_on_launch | boolean readOnly: true title: Ask skip tags on launch |
| ask_tags_on_launch | boolean readOnly: true title: Ask tags on launch |
| ask_variables_on_launch | boolean readOnly: true title: Ask variables on launch |
| can_start_without_user_input | boolean readOnly: true title: Can start without user input |
| defaults | string readOnly: true title: Defaults |
| extra_vars | string title: Extra vars |
| inventory | integer title: Inventory |
| job_tags | string title: Job tags |
| labels | [...] |
| limit | string title: Limit |
| node_prompts_rejected | string readOnly: true title: Node prompts rejected |
| node_templates_missing | string readOnly: true title: Node templates missing |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| survey_enabled | string readOnly: true title: Survey enabled |
| variables_needed_to_start | string readOnly: true title: Variables needed to start |
| workflow_job_template_data | string readOnly: true title: Workflow job template data |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| canceled_on | string($date-time) readOnly: true title: Canceled on The date and time when the cancel request was sent. |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| elapsed | string($decimal) readOnly: true title: Elapsed Elapsed time in seconds that the job ran. |
| extra_vars | string default: title: Extra vars |
| failed | boolean readOnly: true title: Failed |
| finished | string($date-time) readOnly: true title: Finished The date and time the job finished execution. |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| is_sliced_job | boolean default: false title: Is sliced job |
| job_explanation | string minLength: 1 readOnly: true title: Job explanation A status field to indicate the state of the job if it wasn’t able to run and capture stdout |
| job_tags | string title: Job tags |
| job_template | string title: Job template If automatically created for a sliced job run, the job template the workflow job was created from. |
| launch_type | string readOnly: true title: Launch typeEnum: Array [ 9 ] |
| launched_by | string readOnly: true title: Launched by |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| started | string($date-time) readOnly: true title: Started The date and time the job was queued for starting. |
| status | string readOnly: true title: StatusEnum: Array [ 8 ] |
| summary_fields | string readOnly: true title: Summary fields |
| type | string readOnly: true title: Type |
| unified_job_template | string readOnly: true title: unified job template |
| url | string readOnly: true title: Url |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_guid | string maxLength: 128 title: Webhook guid Unique identifier of the event that triggered this webhook |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| work_unit_id | string minLength: 1 readOnly: true title: Work unit id The Receptor work unit ID associated with this job. |
| workflow_job_template | string title: Workflow job template |
| all_parents_must_converge | boolean default: false title: All parents must converge If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node |
| always_nodes | [...] |
| created | string readOnly: true title: Created |
| diff_mode | boolean title: Diff mode |
| do_not_run | boolean default: false title: Do not run Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_data | Extra data{...} |
| failure_nodes | [...] |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| identifier | string maxLength: 512 title: Identifier An identifier coresponding to the workflow job template node that this node was created from. |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job | integer title: Job |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| success_nodes | [...] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| type | string readOnly: true title: Type |
| unified_job_template | integer title: Unified job template |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| workflow_job | string title: Workflow job |
| all_parents_must_converge | boolean default: false title: All parents must converge If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node |
| always_nodes | [...] |
| created | string readOnly: true title: Created |
| diff_mode | boolean title: Diff mode |
| do_not_run | boolean default: false title: Do not run Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run. |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_data | Extra data{...} |
| failure_nodes | [...] |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| identifier | string maxLength: 512 title: Identifier An identifier coresponding to the workflow job template node that this node was created from. |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job | integer title: Job |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| success_nodes | [...] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| type | string readOnly: true title: Type |
| unified_job_template | integer title: Unified job template |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| workflow_job | string title: Workflow job |
| allow_simultaneous | boolean default: false title: Allow simultaneous |
| ask_inventory_on_launch | boolean default: false title: Ask inventory on launch |
| ask_labels_on_launch | boolean default: false title: Ask labels on launch |
| ask_limit_on_launch | boolean default: false title: Ask limit on launch |
| ask_scm_branch_on_launch | boolean default: false title: Ask scm branch on launch |
| ask_skip_tags_on_launch | boolean default: false title: Ask skip tags on launch |
| ask_tags_on_launch | boolean default: false title: Ask tags on launch |
| ask_variables_on_launch | boolean default: false title: Ask variables on launch |
| created | string readOnly: true title: Created |
| description | string default: title: Description |
| extra_vars | string default: title: Extra vars |
| id | integer readOnly: true title: ID |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job_tags | string title: Job tags |
| last_job_failed | boolean readOnly: true title: Last job failed |
| last_job_run | string($date-time) readOnly: true title: Last job run |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| name* | string maxLength: 512 minLength: 1 title: Name |
| next_job_run | string($date-time) readOnly: true title: Next job run |
| organization | integer title: Organization The organization used to determine access to this template. |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| status | string readOnly: true title: StatusEnum: Array [ 13 ] |
| summary_fields | string readOnly: true title: Summary fields |
| survey_enabled | boolean default: false title: Survey enabled |
| type | string readOnly: true title: Type |
| url | string readOnly: true title: Url |
| webhook_credential | integer title: Webhook credential Personal Access Token for posting back the status to the service API |
| webhook_service | string title: Webhook service Service that webhook requests will be accepted from Array [ 2 ] |
| all_parents_must_converge | boolean default: false title: All parents must converge If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node |
| always_nodes | [...] |
| created | string readOnly: true title: Created |
| diff_mode | boolean title: Diff mode |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_data | Extra data{...} |
| failure_nodes | [...] |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| identifier | string default: 00000000-0000-0000-0000-000000000000 maxLength: 512 minLength: 1 title: Identifier An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| success_nodes | [...] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| type | string readOnly: true title: Type |
| unified_job_template | integer title: Unified job template |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| workflow_job_template* | string title: Workflow job template |
| description | string default: title: Description |
| name* | string maxLength: 512 minLength: 1 title: Name |
| timeout | integer default: 0 title: Timeout The amount of time (in seconds) before the approval node expires and fails. |
| all_parents_must_converge | boolean default: false title: All parents must converge If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node |
| always_nodes | [...] |
| created | string readOnly: true title: Created |
| diff_mode | boolean title: Diff mode |
| execution_environment | integer title: Execution environment The container image to be used for execution. |
| extra_data | Extra data{...} |
| failure_nodes | [...] |
| forks | integer minimum: 0 title: Forks |
| id | integer readOnly: true title: ID |
| identifier | string default: 00000000-0000-0000-0000-000000000000 maxLength: 512 minLength: 1 title: Identifier An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. |
| inventory | integer title: Inventory Inventory applied as a prompt, assuming job template prompts for inventory |
| job_slice_count | integer minimum: 0 title: Job slice count |
| job_tags | string title: Job tags |
| job_type | string title: Job typeEnum: Array [ 2 ] |
| limit | string title: Limit |
| modified | string readOnly: true title: Modified |
| related | string readOnly: true title: Related |
| scm_branch | string title: Scm branch |
| skip_tags | string title: Skip tags |
| success_nodes | [...] |
| summary_fields | string readOnly: true title: Summary fields |
| timeout | integer title: Timeout |
| type | string readOnly: true title: Type |
| unified_job_template | integer title: Unified job template |
| url | string readOnly: true title: Url |
| verbosity | string title: VerbosityEnum: Array [ 6 ] |
| workflow_job_template* | string title: Workflow job template |