Is there a play variable which contains the name (and tag) of the AWX execution environment being used?

jpmens · April 5, 2024, 6:03pm

I’d like to be able to report in a play with which execution environment a job template (i.e. playbook) is being run, mainly for debugging purposes.

Is there a magic awx_* (or tower_*) variable which surfaces this information?

fosterseth · April 5, 2024, 7:36pm

it does not appear that we do

github.com

ansible/awx/blob/d06ce8f9119267862fcca00fc85af3a9f323d61c/awx/main/models/unified_jobs.py#L1529


      
                  default_instance_group_names.append(settings.DEFAULT_CONTROL_PLANE_QUEUE_NAME)
          
              default_instance_groups = list(InstanceGroup.objects.filter(name__in=default_instance_group_names))
          
              # assure deterministic precedence by making sure the default group is first
              if (not settings.IS_K8S) and default_instance_groups and default_instance_groups[0].name != settings.DEFAULT_EXECUTION_QUEUE_NAME:
                  default_instance_groups.reverse()
          
              return default_instance_groups
          
          def awx_meta_vars(self):
              """
              The result of this method is used as extra_vars of a job launched
              by AWX, for purposes of client playbook hooks
              """
              r = {}
              for name in JOB_VARIABLE_PREFIXES:
                  r['{}_job_id'.format(name)] = self.pk
                  r['{}_job_launch_type'.format(name)] = self.launch_type
          
              created_by = getattr_dne(self, 'created_by')

you can open an enhancement issue on github, but it’s unlikely to get prioritize by awx developers. This would be a great contribution if you are interested in opening a PR!

Seth

jpmens · April 5, 2024, 10:10pm

Thank you, @fosterseth, that’s a great help. Using awx_job_id (e.g. 294) I can find what I need using the jobs API:

awx jobs get 294 | jq .summary_fields.execution_environment.name
"whEEl"

which is exactly what I need. (I’m desperately trying to figure out why plugins burned into my EE aren’t being found whereas using the same EE in ansible-navigator works, and it worked in AWX on Tuesday … sighs.)

I’m not sure I have the stamina to provide a PR to add the field to awx_meta_vars() though.

system · May 5, 2024, 10:10pm

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Reference AWX Username Get Help awx , playbook , variables	6	421	May 25, 2024
Awx.inventory adding variables issue Get Help awx , collections	9	54	August 20, 2024
AWX support for variables files Get Help awx , documentation , playbook	2	404	March 20, 2024
How to Use AWX 'limit' Value in Extra Vars or Playbook Variables" Get Help awx , ubuntu , template	0	233	May 16, 2024
Extra_vars to Webhooks in AWX? Get Help awx , api	3	267	April 13, 2024

Is there a play variable which contains the name (and tag) of the AWX execution environment being used?

Related topics