category: IT Services provider: IBM commonfields: id: AnsibleTower version: -1 sectionorder: - Connect - Collect configuration: - display: Server URL name: url required: true type: 0 section: Connect - display: Username name: credentials required: true type: 9 section: Connect - display: Is AAP Gateway name: is_aap_gateway type: 8 required: false section: Connect additionalinfo: Whether to connect to an Ansible Automation Platform 2.6+ Gateway. - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect description: Scale IT automation, manage complex deployments, and speed productivity. display: Ansible Automation Platform name: AnsibleTower script: commands: - arguments: - description: The inventory ID for which to retrieve the specific inventory. name: id - defaultValue: '1' description: Page number to retrieve. Default is 1. name: page_number - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the list of inventories. name: ansible-tower-inventories-list outputs: - contextPath: AnsibleAWX.Inventory.id description: Database ID for this inventory. type: Number - contextPath: AnsibleAWX.Inventory.type description: Data type for this inventory. type: String - contextPath: AnsibleAWX.Inventory.url description: URL for this inventory. type: String - contextPath: AnsibleAWX.Inventory.created description: Timestamp indicating when this inventory was created. type: Date - contextPath: AnsibleAWX.Inventory.modified description: Timestamp indicating when this inventory was last modified. type: Date - contextPath: AnsibleAWX.Inventory.name description: Name of this inventory. type: String - contextPath: AnsibleAWX.Inventory.description description: Optional description of this inventory. type: String - contextPath: AnsibleAWX.Inventory.organization description: ID of the organization containing this inventory. type: Number - contextPath: AnsibleAWX.Inventory.kind description: Type of inventory being represented. type: String - contextPath: AnsibleAWX.Inventory.host_filter description: Filter that is applied to the hosts of this inventory. type: String - contextPath: AnsibleAWX.Inventory.variables description: Inventory variables in JSON or YAML format. type: String - contextPath: AnsibleAWX.Inventory.total_inventory_sources description: Total number of external inventory sources configured within this inventory. type: Number - contextPath: AnsibleAWX.Inventory.inventory_sources_with_failures description: Number of external inventory sources in this inventory with failures. type: Number - contextPath: AnsibleAWX.Inventory.insights_credential description: Credentials to be used by hosts belonging to this inventory when accessing Red Hat Insights API. type: Number - contextPath: AnsibleAWX.Inventory.pending_deletion description: Flag indicating the inventory is being deleted. type: Boolean - arguments: - description: ID of the host to retrieve. name: host_id - description: ID of the inventory to retrieve. name: inventory_id - defaultValue: '1' description: Page number to retrieve. Default is 1. name: page - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the list of hosts. If an inventory ID is specified, retrieve the host located under the specific inventory. name: ansible-tower-hosts-list outputs: - contextPath: AnsibleAWX.Host.id description: Database ID for this host. type: Number - contextPath: AnsibleAWX.Host.type description: Data type for this host. type: String - contextPath: AnsibleAWX.Host.url description: URL for this host. type: String - contextPath: AnsibleAWX.Host.created description: Timestamp indicating when this host was created. type: Date - contextPath: AnsibleAWX.Host.modified description: Timestamp indicating when this host was last modified. type: Date - contextPath: AnsibleAWX.Host.name description: Name of this host. type: String - contextPath: AnsibleAWX.Host.description description: Optional description of this host. type: String - contextPath: AnsibleAWX.Host.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Host.enabled description: Whether this host is online and available for running jobs. type: Boolean - contextPath: AnsibleAWX.Host.instance_id description: The value used by the remote inventory source to uniquely identify the host. type: String - contextPath: AnsibleAWX.Host.variables description: Host variables in JSON or YAML format. type: String - contextPath: AnsibleAWX.Host.last_job description: ID of the last job that was run on the host. type: Number - contextPath: AnsibleAWX.Host.insights_system_id description: Red Hat Insights host unique identifier. type: String - contextPath: AnsibleAWX.Host.ansible_facts_modified description: The date and time ansible_facts was last modified. type: Date - arguments: - description: The ID of the inventory under which to create the host. name: inventory_id required: true - description: Unique name for the host. name: host_name required: true - description: Optional description of this host. name: description - defaultValue: 'True' description: Whether this host will be online and available for running jobs. Default is "True". name: enabled description: Creates a host under the specified inventory ID and with the specified name. name: ansible-tower-host-create outputs: - contextPath: AnsibleAWX.Host.id description: Database ID for this host. type: Number - contextPath: AnsibleAWX.Host.type description: Data type for this host. type: String - contextPath: AnsibleAWX.Host.url description: URL for this host. type: String - contextPath: AnsibleAWX.Host.created description: Timestamp indicating when this host was created. type: Date - contextPath: AnsibleAWX.Host.modified description: Timestamp indicating when this host was last modified. type: Date - contextPath: AnsibleAWX.Host.name description: Name of this host. type: String - contextPath: AnsibleAWX.Host.description description: Optional description of this host. type: String - contextPath: AnsibleAWX.Host.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Host.enabled description: Whether this host is online and available for running jobs. type: Boolean - contextPath: AnsibleAWX.Host.instance_id description: The value used by the remote inventory source to uniquely identify the host. type: String - contextPath: AnsibleAWX.Host.variables description: Host variables in JSON or YAML format. type: String - contextPath: AnsibleAWX.Host.has_active_failures description: Whether host has active failures. type: Boolean - contextPath: AnsibleAWX.Host.last_job description: The ID of the last job. type: Number - contextPath: AnsibleAWX.Host.insights_system_id description: Red Hat Insights host unique identifier. type: String - contextPath: AnsibleAWX.Host.ansible_facts_modified description: The date and time ansible_facts was last modified. type: Date - arguments: - description: The ID of the host to delete. name: host_id required: true description: Deletes the specified host. name: ansible-tower-host-delete outputs: - contextPath: AnsibleAWX.Host.id description: Database ID for this host. type: Number - contextPath: AnsibleAWX.Host.Deleted description: Whether this host was deleted. type: Boolean - arguments: - description: Inventory ID of the jobs that are managed with hosts under this inventory. name: inventory_id - defaultValue: '1' description: Page number to retrieve. Default is 1. name: page - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search - description: The ID of the job template. name: id description: Retrieves the list of job templates. name: ansible-tower-job-templates-list outputs: - contextPath: AnsibleAWX.JobTemplate.id description: Database ID for this job template. type: Number - contextPath: AnsibleAWX.JobTemplate.type description: Data type for this job template. type: String - contextPath: AnsibleAWX.JobTemplate.url description: URL for this job template. type: String - contextPath: AnsibleAWX.JobTemplate.created description: Timestamp indicating when this job template was created. type: Date - contextPath: AnsibleAWX.JobTemplate.modified description: Timestamp indicating when this job template was last modified. type: Date - contextPath: AnsibleAWX.JobTemplate.name description: Name of this job template. type: String - contextPath: AnsibleAWX.JobTemplate.description description: Optional description of this job template. type: String - contextPath: AnsibleAWX.JobTemplate.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.JobTemplate.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.JobTemplate.project description: Project ID. type: Number - contextPath: AnsibleAWX.JobTemplate.playbook description: Playbook name. type: String - contextPath: AnsibleAWX.JobTemplate.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.JobTemplate.extra_vars description: Extra command line variables that were passed to the playbook. type: String - contextPath: AnsibleAWX.JobTemplate.job_tags description: Job tags. These tags are useful when you have a large playbook and you want to run a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.JobTemplate.skip_tags description: Skip tags. These tags are useful when you have a large playbook and you want to skip a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.JobTemplate.timeout description: The number of seconds to wait before the task is canceled. type: Number - contextPath: AnsibleAWX.JobTemplate.last_job_run description: Timestamp indicating when the last job ran. type: Date - contextPath: AnsibleAWX.JobTemplate.last_job_failed description: Whether the last job failed. type: Boolean - contextPath: AnsibleAWX.JobTemplate.next_job_run description: Timestamp of the next job run. type: Date - contextPath: AnsibleAWX.JobTemplate.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.JobTemplate.host_config_key description: The host config key that ran the job. type: String - contextPath: AnsibleAWX.JobTemplate.survey_enabled description: Whether the job template survey was enabled. type: Boolean - contextPath: AnsibleAWX.JobTemplate.become_enabled description: Whether the job template was enabled. type: Boolean - contextPath: AnsibleAWX.JobTemplate.custom_virtualenv description: Local absolute file path containing a custom Python virtualenv to use. type: String - contextPath: AnsibleAWX.JobTemplate.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - arguments: - description: ID of a specific credential. name: id - defaultValue: '1' description: Page number to retrieve. Default is 1. name: page - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the list of credentials. If an ID is specified, retrieve the specific credential. name: ansible-tower-credentials-list outputs: - contextPath: AnsibleAWX.Credential.id description: Database ID for this credential. type: Number - contextPath: AnsibleAWX.Credential.type description: Data type for this credential. type: String - contextPath: AnsibleAWX.Credential.url description: URL for this credential. type: String - contextPath: AnsibleAWX.Credential.created description: Timestamp indicating when this credential was created. type: Date - contextPath: AnsibleAWX.Credential.modified description: Timestamp indicating when this credential was last modified. type: Date - contextPath: AnsibleAWX.Credential.name description: Name of this credential. type: String - contextPath: AnsibleAWX.Credential.description description: Optional description of this credential. type: String - contextPath: AnsibleAWX.Credential.organization description: Organization ID. Inherits permissions from organization roles. type: Number - contextPath: AnsibleAWX.Credential.credential_type description: The type of credential to create. type: Number - contextPath: AnsibleAWX.Credential.inputs.username description: Username. type: String - arguments: - description: ID of the job template to launch. name: job_template_id required: true - description: The ID of the inventory that contains the host you want this job to manage if the job template does not have an inventory to start. name: inventory_id - description: The ID of the credentials that allow Tower to access the node this job will be run against. name: credentials_id - description: Command line variables to pass to the playbook in JSON format. name: extra_variables description: Launches the job template. name: ansible-tower-job-launch outputs: - contextPath: AnsibleAWX.Job.id description: Database ID for this job. type: Number - contextPath: AnsibleAWX.Job.type description: Data type for this job. type: String - contextPath: AnsibleAWX.Job.url description: URL for this job. type: String - contextPath: AnsibleAWX.Job.created description: Timestamp indicating when this job was created. type: Date - contextPath: AnsibleAWX.Job.modified description: Timestamp indicating when this job was last modified. type: Date - contextPath: AnsibleAWX.Job.name description: Name of this job. type: String - contextPath: AnsibleAWX.Job.description description: Optional description of this job. type: String - contextPath: AnsibleAWX.Job.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.Job.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Job.project description: Project ID. type: Number - contextPath: AnsibleAWX.Job.playbook description: Playbook name. type: String - contextPath: AnsibleAWX.Job.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.Job.extra_vars description: Extra command line variables that were passed to the playbook. type: String - contextPath: AnsibleAWX.Job.job_tags description: Job tags. These tags are useful when you have a large playbook and you want to run a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.skip_tags description: Skip tags. These tags are useful when you have a large playbook and you want to skip a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.timeout description: The number of seconds to wait before the task is canceled. type: Number - contextPath: AnsibleAWX.Job.launch_type description: Launch type of the job. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.Job.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.Job.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.Job.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.Job.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.Job.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.Job.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.Job.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.Job.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.Job.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.Job.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.Job.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.Job.job_template description: The ID of the job template for this job. type: Number - contextPath: AnsibleAWX.Job.scm_revision description: The source control management revision of the project used for this job, if available. type: String - contextPath: AnsibleAWX.Job.instance_group description: The instance group the job was run under. type: Number - contextPath: AnsibleAWX.Job.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - arguments: - description: ID of the job to relaunch. name: job_id required: true - auto: PREDEFINED defaultValue: all description: 'The hosts to relaunch the job. Can be all the hosts or only the ones where the job failed. Possible values are: "all" and "failed". Default is "all".' name: relaunch_hosts predefined: - all - failed - description: Credential ID. name: credentials_id description: Relaunch a job. name: ansible-tower-job-relaunch outputs: - contextPath: AnsibleAWX.Job.id description: Database ID for this job. type: Number - contextPath: AnsibleAWX.Job.type description: Data type for this job. type: String - contextPath: AnsibleAWX.Job.url description: URL for this job. type: String - contextPath: AnsibleAWX.Job.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.Job.created description: Timestamp indicating when this job was created. type: Date - contextPath: AnsibleAWX.Job.modified description: Timestamp indicating when this job was last modified. type: Date - contextPath: AnsibleAWX.Job.name description: Name of this job. type: String - contextPath: AnsibleAWX.Job.description description: Optional description of this job. type: String - contextPath: AnsibleAWX.Job.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.Job.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Job.project description: Project ID. type: Number - contextPath: AnsibleAWX.Job.playbook description: Playbook name. type: String - contextPath: AnsibleAWX.Job.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.Job.extra_vars description: Extra command line variables that were passed to the playbook. type: String - contextPath: AnsibleAWX.Job.job_tags description: Job tags. These tags are useful when you have a large playbook and you want to run a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.skip_tags description: Skip tags. These tags are useful when you have a large playbook and you want to skip a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.timeout description: The number of seconds to wait before the task is canceled. type: Number - contextPath: AnsibleAWX.Job.launch_type description: Launch type of the job. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.Job.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.Job.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.Job.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.Job.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.Job.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.Job.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.Job.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.Job.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.Job.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.Job.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.Job.job_template description: The ID of the job template of this job. type: Number - contextPath: AnsibleAWX.Job.scm_revision description: The source control management revision of the project used for this job, if available. type: String - contextPath: AnsibleAWX.Job.instance_group description: The instance group the job was run under. type: Number - contextPath: AnsibleAWX.Job.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - arguments: - description: The ID of the job to cancel. name: job_id required: true description: Cancels a pending or running job. name: ansible-tower-job-cancel outputs: - contextPath: AnsibleAWX.Job.id description: Database ID for this job. type: Number - contextPath: AnsibleAWX.Job.type description: Data type for this job. type: String - contextPath: AnsibleAWX.Job.url description: URL for this job. type: String - contextPath: AnsibleAWX.Job.created description: Timestamp indicating when this job was created. type: Date - contextPath: AnsibleAWX.Job.modified description: Timestamp indicating when this job was last modified. type: Date - contextPath: AnsibleAWX.Job.name description: Name of this job. type: String - contextPath: AnsibleAWX.Job.description description: Optional description of this job. type: String - contextPath: AnsibleAWX.Job.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.Job.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Job.project description: Project ID. type: Number - contextPath: AnsibleAWX.Job.playbook description: Playbook name. type: String - contextPath: AnsibleAWX.Job.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.Job.extra_vars description: Extra command line variables that were passed to the playbook. type: String - contextPath: AnsibleAWX.Job.job_tags description: Job tags. These tags are useful when you have a large playbook and you want to run a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.skip_tags description: Skip tags. These tags are useful when you have a large playbook and you want to skip a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.timeout description: The number of seconds to wait before the task is canceled. type: Number - contextPath: AnsibleAWX.Job.launch_type description: Launch type of the job. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.Job.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.Job.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.Job.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.Job.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.Job.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.Job.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.Job.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.Job.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.Job.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.Job.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.Job.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.Job.job_template description: The ID of the job template of this job. type: Number - contextPath: AnsibleAWX.Job.scm_revision description: The source control management revision of the project used for this job, if available. type: String - contextPath: AnsibleAWX.Job.instance_group description: The instance group the job was run under. type: Number - contextPath: AnsibleAWX.Job.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - arguments: - description: The ID of the job. name: job_id required: true - auto: PREDEFINED defaultValue: 'True' description: 'Whether to print the output. Possible values are: "True" and "False". Default is "True".' name: print_output predefined: - 'True' - 'False' - description: The string by which to filter lines in the standard output. For example, enter 'success' to filter the standard output lines containing this word. name: text_filter description: Retrieves the standard output by running the provided job. name: ansible-tower-job-stdout outputs: - contextPath: AnsibleAWX.JobStdout.job_id description: The ID of the job. type: Number - contextPath: AnsibleAWX.JobStdout.content description: The standard output content. type: String - arguments: - description: The ID of the job. name: job_id required: true - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the job status. name: ansible-tower-job-status outputs: - contextPath: AnsibleAWX.Job.id description: Database ID for this job. type: Number - contextPath: AnsibleAWX.Job.type description: Data type for this job. type: String - contextPath: AnsibleAWX.Job.url description: URL for this job. type: String - contextPath: AnsibleAWX.Job.created description: Timestamp indicating when this job was created. type: Date - contextPath: AnsibleAWX.Job.modified description: Timestamp indicating when this job was last modified. type: Date - contextPath: AnsibleAWX.Job.name description: Name of this job. type: String - contextPath: AnsibleAWX.Job.description description: Optional description of this job. type: String - contextPath: AnsibleAWX.Job.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.Job.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.Job.project description: Project ID. type: Number - contextPath: AnsibleAWX.Job.playbook description: Playbook name. type: String - contextPath: AnsibleAWX.Job.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.Job.extra_vars description: Extra command line variables that were passed to the playbook. type: String - contextPath: AnsibleAWX.Job.job_tags description: Job tags. These tags are useful when you have a large playbook and you want to run a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.skip_tags description: Skip tags. These tags are useful when you have a large playbook and you want to skip a specific part of a playbook or task. type: String - contextPath: AnsibleAWX.Job.timeout description: The number of seconds to wait before the task is canceled. type: Number - contextPath: AnsibleAWX.Job.launch_type description: Launch type of the job. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.Job.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.Job.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.Job.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.Job.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.Job.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.Job.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.Job.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.Job.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.Job.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.Job.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.Job.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.Job.job_template description: The ID of the job template of this job. type: Number - contextPath: AnsibleAWX.Job.scm_revision description: The source control management revision of the project used for this job, if available. type: String - contextPath: AnsibleAWX.Job.instance_group description: The instance group the job was run under. type: Number - contextPath: AnsibleAWX.Job.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - arguments: - description: The ID of the job event. name: id - defaultValue: '1' description: The page number to retrieve. Default is 1. name: page - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the list of job events, you can use the id filter to get one job event, you can use the ansible-tower-job-event-list-by-id command to filter through events by job id. name: ansible-tower-job-events-list outputs: - contextPath: AnsibleAWX.JobEvents.id description: Database ID for this job event. type: Number - contextPath: AnsibleAWX.JobEvents.type description: Data type for this job event. type: String - contextPath: AnsibleAWX.JobEvents.url description: URL for this job event. type: String - contextPath: AnsibleAWX.JobEvents.created description: Timestamp indicating when this job event was created. type: Date - contextPath: AnsibleAWX.JobEvents.modified description: Timestamp indicating when this job event was last modified. type: Date - contextPath: AnsibleAWX.JobEvents.job description: Job ID. type: Number - contextPath: AnsibleAWX.JobEvents.event description: The specific event. For example, runner_on_failed (Host Failed), runner_on_start (Host Started), etc. type: String - contextPath: AnsibleAWX.JobEvents.counter description: Job event counter. type: Number - contextPath: AnsibleAWX.JobEvents.event_display description: Event display. For example, Playbook Started. type: String - contextPath: AnsibleAWX.JobEvents.event_level description: The event level. type: Number - contextPath: AnsibleAWX.JobEvents.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.JobEvents.changed description: Whether the job changed. type: Boolean - contextPath: AnsibleAWX.JobEvents.uuid description: UUID of the job event. type: String - contextPath: AnsibleAWX.JobEvents.parent_uuid description: Parent UUID. type: String - contextPath: AnsibleAWX.JobEvents.host description: Host ID associated with the event. type: Number - contextPath: AnsibleAWX.JobEvents.host_name description: Host name associated with the event. type: String - contextPath: AnsibleAWX.JobEvents.playbook description: Playbook name of this job. type: String - contextPath: AnsibleAWX.JobEvents.task description: Task name. type: String - contextPath: AnsibleAWX.JobEvents.stdout description: Standard output of the job. type: String - contextPath: AnsibleAWX.JobEvents.start_line description: Starting line number of the execution. type: Number - contextPath: AnsibleAWX.JobEvents.end_line description: Ending line number of the execution. type: Number - arguments: - description: ID of the inventory. name: inventory_id required: true - description: ID of the credential. name: credential_id required: true - auto: PREDEFINED description: The name of the module.Modules are discrete units of code that can be used from the command line or in a playbook task. Ansible ships with a number of modules that can be executed directly on remote hosts or through playbooks. name: module_name predefined: - command - shell - yum - apt - apt_key - apt_repository - apt_rpm - service - group - user - mount - ping - selinux - setup - win_ping - win_service - win_updates - win_group - win_user required: true - description: Module arguments. name: module_args description: Creates new ad hoc commands. name: ansible-tower-adhoc-command-launch outputs: - contextPath: AnsibleAWX.AdhocCommand.id description: Database ID for this ad hoc command. type: Number - contextPath: AnsibleAWX.AdhocCommand.type description: Data type for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.url description: URL for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.created description: Timestamp indicating when this ad hoc command was created. type: Date - contextPath: AnsibleAWX.AdhocCommand.modified description: Timestamp indicating when this ad hoc command was last modified. type: Date - contextPath: AnsibleAWX.AdhocCommand.name description: Name of this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.launch_type description: Launch type of the job. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.AdhocCommand.status description: Status of the job. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.AdhocCommand.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.AdhocCommand.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.AdhocCommand.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.AdhocCommand.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.AdhocCommand.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.AdhocCommand.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.AdhocCommand.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.AdhocCommand.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.AdhocCommand.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.AdhocCommand.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.AdhocCommand.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - contextPath: AnsibleAWX.AdhocCommand.module_name description: Selected module name. type: String - contextPath: AnsibleAWX.AdhocCommand.module_args description: Module arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.extra_vars description: Extra variables needed for the module running. type: String - contextPath: AnsibleAWX.AdhocCommand.become_enabled description: Whether the ad hoc command become enabled. type: Boolean - arguments: - description: The ID of the command. name: command_id required: true description: Launch a new job to run the ad hoc command. name: ansible-tower-adhoc-command-relaunch outputs: - contextPath: AnsibleAWX.AdhocCommand.id description: Database ID for this ad hoc command. type: Number - contextPath: AnsibleAWX.AdhocCommand.type description: Data type for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.url description: URL for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.created description: Timestamp indicating when this ad hoc command was created. type: Date - contextPath: AnsibleAWX.AdhocCommand.modified description: Timestamp indicating when this ad hoc command was last modified. type: Date - contextPath: AnsibleAWX.AdhocCommand.name description: Name of this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.launch_type description: Launch type. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.AdhocCommand.status description: Status. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.AdhocCommand.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.AdhocCommand.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.AdhocCommand.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.AdhocCommand.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.AdhocCommand.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.AdhocCommand.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.AdhocCommand.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.AdhocCommand.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.AdhocCommand.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.AdhocCommand.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.AdhocCommand.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - contextPath: AnsibleAWX.AdhocCommand.module_name description: Selected module name. type: String - contextPath: AnsibleAWX.AdhocCommand.module_args description: Module arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.extra_vars description: Extra variables needed for that module running. type: String - contextPath: AnsibleAWX.AdhocCommand.become_enabled description: Whether the ad hoc command become enabled. type: Boolean - arguments: - description: The ID of the command to cancel. name: command_id required: true description: Cancel a job of the specified ad hoc command. name: ansible-tower-adhoc-command-cancel outputs: - contextPath: AnsibleAWX.AdhocCommand.id description: Database ID for this ad hoc command. type: Number - contextPath: AnsibleAWX.AdhocCommand.type description: Data type for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.url description: URL for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.created description: Timestamp indicating when this ad hoc command was created. type: Date - contextPath: AnsibleAWX.AdhocCommand.modified description: Timestamp indicating when this ad hoc command was last modified. type: Date - contextPath: AnsibleAWX.AdhocCommand.name description: Name of this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.launch_type description: Launch type. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.AdhocCommand.status description: Status. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.AdhocCommand.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.AdhocCommand.started description: The date and time the job was queued to start. type: Unknown - contextPath: AnsibleAWX.AdhocCommand.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.AdhocCommand.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.AdhocCommand.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.AdhocCommand.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.AdhocCommand.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.AdhocCommand.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.AdhocCommand.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.AdhocCommand.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.AdhocCommand.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.AdhocCommand.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.AdhocCommand.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - contextPath: AnsibleAWX.AdhocCommand.module_name description: Selected module name. type: String - contextPath: AnsibleAWX.AdhocCommand.module_args description: Module arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.extra_vars description: Extra variables needed for that module running. type: String - contextPath: AnsibleAWX.AdhocCommand.become_enabled description: Whether the ad hoc command become enabled. type: Boolean - arguments: - description: The ID of the command to run. name: command_id required: true - auto: PREDEFINED defaultValue: 'True' description: 'Prints the ad hoc command output. Possible values are: "True" and "False". Default is "True".' name: print_output predefined: - 'True' - 'False' - description: The string by which to filter lines in the standard output. For example, enter 'success' to filter the standard output lines containing this word. name: text_filter description: Retrieves the standard output from running this ad hoc command. name: ansible-tower-adhoc-command-stdout outputs: - contextPath: AnsibleAWX.AdhocCommandStdout.content description: Standard output content. type: String - arguments: - description: The ID of the command. name: command_id required: true description: Retrieves a single ad hoc command status. name: ansible-tower-adhoc-command-status outputs: - contextPath: AnsibleAWX.AdhocCommand.id description: Database ID for this ad hoc command. type: Number - contextPath: AnsibleAWX.AdhocCommand.type description: Data type for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.url description: URL for this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.created description: Timestamp indicating when this ad hoc command was created. type: Date - contextPath: AnsibleAWX.AdhocCommand.modified description: Timestamp indicating when this ad hoc command was last modified. type: Date - contextPath: AnsibleAWX.AdhocCommand.name description: Name of this ad hoc command. type: String - contextPath: AnsibleAWX.AdhocCommand.launch_type description: Launch type. Can be manual, relaunch, callback, scheduled, dependency, workflow, webhook, sync, or scm. type: String - contextPath: AnsibleAWX.AdhocCommand.status description: Status. Can be new, pending, waiting, running, successful, failed, error, canceled, or never updated. type: String - contextPath: AnsibleAWX.AdhocCommand.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.AdhocCommand.started description: The date and time the job was queued to start. type: Date - contextPath: AnsibleAWX.AdhocCommand.finished description: The date and time the job finished execution. type: Date - contextPath: AnsibleAWX.AdhocCommand.elapsed description: The amount of time in seconds that it took the job to run. type: Number - contextPath: AnsibleAWX.AdhocCommand.job_args description: Job arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.job_cwd description: Current working directory (CWD) of the job. type: String - contextPath: AnsibleAWX.AdhocCommand.job_explanation description: Indicates the state of the job if it was not able to run and capture the standard output. type: String - contextPath: AnsibleAWX.AdhocCommand.execution_node description: The node the job executed on. type: String - contextPath: AnsibleAWX.AdhocCommand.controller_node description: The instance that managed the isolated execution environment. type: String - contextPath: AnsibleAWX.AdhocCommand.result_traceback description: The traceback of the result. type: String - contextPath: AnsibleAWX.AdhocCommand.job_type description: Job type. Possible values are "run" and "check". type: String - contextPath: AnsibleAWX.AdhocCommand.inventory description: Inventory ID. type: Number - contextPath: AnsibleAWX.AdhocCommand.limit description: The host pattern that will limit the list of hosts that will be managed or affected by the playbook. type: String - contextPath: AnsibleAWX.AdhocCommand.credential description: Credential ID that allowed Tower to access the node this job was run against. type: Number - contextPath: AnsibleAWX.AdhocCommand.module_name description: Selected module name. type: String - contextPath: AnsibleAWX.AdhocCommand.module_args description: Module arguments. type: String - contextPath: AnsibleAWX.AdhocCommand.extra_vars description: Extra variables needed for that module running. type: String - contextPath: AnsibleAWX.AdhocCommand.become_enabled description: Whether the ad hoc command become enabled. type: Boolean - arguments: - description: The ID of the job event. name: job_id required: true - defaultValue: '1' description: The page number to retrieve. Default is 1. name: page - defaultValue: '50' description: Page size. Default is 50. name: page_size - description: The search query string used to perform a case-insensitive search within all designated text fields of a model. name: search description: Retrieves the list of job events of specific job. name: ansible-tower-job-events-list-by-id outputs: - contextPath: AnsibleAWX.JobEvents.id description: Database ID for this job event. type: Number - contextPath: AnsibleAWX.JobEvents.type description: Data type for this job event. type: String - contextPath: AnsibleAWX.JobEvents.url description: URL for this job event. type: String - contextPath: AnsibleAWX.JobEvents.created description: Timestamp indicating when this job event was created. type: Date - contextPath: AnsibleAWX.JobEvents.modified description: Timestamp indicating when this job event was last modified. type: Date - contextPath: AnsibleAWX.JobEvents.job description: Job ID. type: Number - contextPath: AnsibleAWX.JobEvents.event description: The specific event. For example, runner_on_failed (Host Failed), runner_on_start (Host Started), etc. type: String - contextPath: AnsibleAWX.JobEvents.counter description: Job event counter. type: Number - contextPath: AnsibleAWX.JobEvents.event_display description: Event display. For example, Playbook Started. type: String - contextPath: AnsibleAWX.JobEvents.event_level description: The event level. type: Number - contextPath: AnsibleAWX.JobEvents.failed description: Whether the job failed. type: Boolean - contextPath: AnsibleAWX.JobEvents.changed description: Whether the job changed. type: Boolean - contextPath: AnsibleAWX.JobEvents.uuid description: UUID of the job event. type: String - contextPath: AnsibleAWX.JobEvents.parent_uuid description: Parent UUID. type: String - contextPath: AnsibleAWX.JobEvents.host description: Host ID associated with the event. type: Number - contextPath: AnsibleAWX.JobEvents.host_name description: Host name associated with the event. type: String - contextPath: AnsibleAWX.JobEvents.playbook description: Playbook name of this job. type: String - contextPath: AnsibleAWX.JobEvents.task description: Task name. type: String - contextPath: AnsibleAWX.JobEvents.stdout description: Standard output of the job. type: String - contextPath: AnsibleAWX.JobEvents.start_line description: Starting line number of the execution. type: Number - contextPath: AnsibleAWX.JobEvents.end_line description: Ending line number of the execution. type: Number - contextPath: AnsibleAWX.JobEvents.event_data description: Job's raw event data. type: String dockerimage: demisto/python3:3.12.13.10116658 runonce: false script: '-' subtype: python3 type: python tests: - AnsibleTower_Test_playbook fromversion: 5.0.0