26장. 사용자 정의 알림에 지원되는 속성
지원되는 작업 속성 목록과 알림을 위한 메시지 텍스트를 구성하는 적절한 구문에 대해 알아봅니다.
다음은 지원되는 작업 속성입니다.
-
allow_simultaneous- (boolean) 이 작업과 연결된 작업 템플릿에서 여러 작업을 동시에 실행할 수 있는지 여부를 나타냅니다. -
controller_node- (문자열) 격리된 실행 환경을 관리하는 인스턴스입니다. -
created- (datetime) 이 작업이 생성된 타임스탬프입니다. -
custom_virtualenv- (문자열) 작업을 실행하는 데 사용되는 사용자 지정 가상 환경입니다. -
Description- (문자열) 작업에 대한 선택적 설명입니다. -
diff_mode- (boolean) 활성화하면 호스트의 템플릿 파일에 대한 텍스트 변경 사항이 표준 출력에 표시됩니다. -
elapsed- (decimal) 작업이 실행된 경과된 시간(초)입니다. -
execution_node- (문자열) 작업이 실행되는 노드입니다. -
failed- (부울) 작업이 실패한 경우 True입니다. -
finished- (날짜/시간) 작업 실행이 완료된 날짜 및 시간입니다. -
force_handlers- (boolean) 핸들러가 강제 적용되면 해당 호스트에서 작업이 실패하더라도 알림을 받을 때 실행됩니다. 연결할 수 없는 호스트와 같은 일부 조건에서도 처리기가 실행되지 않을 수 있습니다. -
포크- (정수) 이 작업에 요청된 포크 수입니다. -
id- (정수) 이 작업의 데이터베이스 ID입니다. -
job_explanation- (문자열)stdout을 실행하고 캡처할 수 없는 경우 작업 상태를 나타내는 status 필드입니다. -
job_slice_count- (정수) 슬라이스된 작업의 일부로 실행하는 경우 총 슬라이스 수입니다(1인 경우 작업은 슬라이스된 작업의 일부가 아님). -
job_slice_number- (정수) 슬라이스된 작업의 일부로 실행하면 이 ID가 작동하는 인벤토리 슬라이스의 ID입니다(라우드된 작업의 일부가 아닌 경우 속성은 사용되지 않음). -
job_tags- (문자열) 지정된 태그가 있는 작업만 실행됩니다. -
job_type- (선택) 이 값은실행,확인또는검사일 수 있습니다. -
launch_type- (선택)수동,다시 시작,콜백,스케줄링된,종속성,워크플로우,동기화또는scm. -
limit- (문자열) 지정된 경우 이 호스트 세트로 제한된 플레이북 실행입니다. -
modified- (datetime) 이 작업이 마지막으로 수정된 타임스탬프입니다. -
name- (문자열) 이 작업의 이름입니다. -
playbook- (문자열) 실행된 플레이북입니다. -
scm_revision- (문자열) 이 작업에 사용된 프로젝트의 scm 리버전입니다(사용 가능한 경우). -
SKIP_TAGS - (문자열) 지정된 경우 플레이북 실행에서 이 태그 세트를 건너뜁니다. -
start_at_task- (문자열) 지정된 경우 이 이름과 일치하는 작업에서 플레이북 실행이 시작됩니다. -
started- (datetime) 작업이 시작 대기 중인 날짜 및 시간입니다. -
status- (선택) 이는새로운,pending,waiting,running,successful,failed,error또는canceled일 수 있습니다. -
timeout- (정수) 작업을 취소하기 전에 실행할 시간(초)입니다. -
type- (선택) 이 작업의 데이터 유형입니다. -
url- (문자열) 이 작업의 URL입니다. -
use_fact_cache- (boolean) 작업에 대해 활성화된 경우 자동화 컨트롤러는 데이터베이스에 대한 플레이북 실행이 끝날 때 Ansible 사실 캐시 플러그인 역할을 하며 Ansible에서 사용할 팩트를 캐시합니다. 상세 정보 표시- (선택) 0~5(정상 ~ WinRM 디버그에 해당).host_status_counts(각 상태에 고유하게 할당된 호스트 수)-
건너뛴(정수) -
OK(정수) -
변경됨(정수) -
실패(정수) -
다크(정수) -
처리됨(정수) -
구조됨(정수) -
무시됨(정수) -
실패(boolean)
-
summary_fields:인벤토리-
ID- (정수) 인벤토리의 데이터베이스 ID입니다. -
name- (문자열) 인벤토리의 이름입니다. -
Description- (문자열) 인벤토리에 대한 선택적 설명입니다. -
has_active_failures- (boolean) (더 이상 사용되지 않음) 이 인벤토리의 호스트가 실패했는지 여부를 나타내는 플래그입니다. -
total_hosts- (더 이상 사용되지 않음)(정수) 이 인벤토리의 총 호스트 수입니다. -
hosts_with_active_failures- (더 이상 사용되지 않음)(정수) 활성 오류가 있는 이 인벤토리의 호스트 수입니다. -
total_groups- (더 이상 사용되지 않음)(정수) 이 인벤토리의 총 그룹 수입니다. -
groups_with_active_failures- (더 이상 사용되지 않음)(정수) 활성 오류가 있는 이 인벤토리의 호스트 수입니다. -
has_inventory_sources- (더 이상 사용되지 않음)(boolean) 이 인벤토리에 외부 인벤토리 소스가 있는지 여부를 나타내는 플래그입니다. -
total_inventory_sources- (int) 이 인벤토리 내에 구성된 총 외부 인벤토리 소스 수입니다. -
inventory_sources_with_failures- (int) 실패와 함께 이 인벤토리의 외부 인벤토리 소스 수입니다. -
organization_id- (id) 이 인벤토리가 포함된 조직입니다. -
kind- (선택)(빈 문자열)(호스트가 인벤토리와 직접 연결되어 있음을 나타내는) 또는스마트
-
project-
id- (정수) 프로젝트의 데이터베이스 ID입니다. -
name- (문자열) 프로젝트의 이름입니다. -
Description(문자열) 프로젝트에 대한 선택적 설명입니다. -
status- (선택)새로운,보류 중, 대기 중,실행중 ,성공,실패,오류,취소됨,업데이트되지않음 ,확인또는누락 중 하나입니다. -
scm_type(choice) one of (empty string),git,hg,svn,insights.
-
job_template-
id- (정수) 작업 템플릿의 데이터베이스 ID입니다. -
Description- (문자열) 프로젝트에 대한 선택적 설명입니다. -
status- (선택)새로운,보류 중, 대기 중,실행중 ,성공,실패,오류,취소됨,업데이트되지않음 ,확인또는누락 중 하나입니다.
-
job_template-
id- (정수) 작업 템플릿의 데이터베이스 ID입니다. -
name- (문자열) 작업 템플릿의 이름입니다. -
Description- (문자열) 작업 템플릿에 대한 선택적 설명입니다.
-
unified_job_template-
id- (정수) 통합 작업 템플릿의 데이터베이스 ID입니다. -
name- (문자열) 통합 작업 템플릿의 이름입니다. -
설명- (문자열) 통합 작업 템플릿에 대한 선택적 설명입니다. -
unified_job_type- (선택) 작업 ,workflow_또는jobproject_update와 같은 통합 작업 유형입니다.
-
instance_group-
id- (정수) 인스턴스 그룹의 데이터베이스 ID입니다. -
name- (문자열) 인스턴스 그룹의 이름입니다.
-
created_by-
id- (정수) 작업을 시작한 사용자의 데이터베이스 ID입니다. -
username- (문자열) 작업을 시작한 사용자 이름입니다. -
first_name- (문자열) 첫 번째 이름입니다. -
last_name- (문자열) 마지막 이름입니다.
-
labels-
count- (정수) 라벨 수입니다. -
결과- 레이블을 나타내는 사전 목록입니다. 예를 들어 {"id": 5, "name": "database jobs"}가 있습니다.
-
그룹화된 중괄호 {{ }}를 사용하여 사용자 정의 알림 메시지에서 작업에 대한 정보를 참조할 수 있습니다. 특정 작업 속성은 점 표기법을 사용하여 액세스할 수 있습니다(예: {{ job.summary_fields.inventory.name }}). 중괄호 앞 또는 주위에 사용된 모든 문자 또는 일반 텍스트(예: 작업 ID의 경우 "#", 작은따옴표의 경우 "#")를 추가하여 일부 설명자를 표시할 수 있습니다. 사용자 지정 메시지에는 메시지 전체에서 여러 변수가 포함될 수 있습니다.
{{ job_friendly_name }} {{ job.id }} ran on {{ job.execution_node }} in {{ job.elapsed }} seconds.다음은 템플릿에 추가할 수 있는 추가 변수입니다.
-
approval_node_name- (문자열) 승인 노드 이름입니다. -
approval_status- (선택)승인됨,거부됨및timed_out중 하나입니다. -
URL- (문자열) 알림이 출력되는 작업의 URL입니다(시작,성공,실패,승인 알림에적용됨). -
workflow_url- (문자열) 관련 승인 노드의 URL입니다. 이를 통해 알림 수신자는 관련 워크플로우 작업 페이지로 이동하여 상황을 검사할 수 있습니다. 예를 들어이 노드는 {{workflow_url }}에서 볼 수 있습니다. 승인 관련 알림의 경우url및workflow_url이 모두 동일합니다. -
job_friendly_name- (문자열) 작업의 친숙한 이름입니다. job_metadata- (문자열) JSON 문자열로 된 작업 메타데이터입니다. 예를 들면 다음과 같습니다.{'url': 'https://automationcontroller.example.com/$/jobs/playbook/13', 'traceback': '', 'status': 'running', 'started': '2019-08-07T21:46:38.362630+00:00', 'project': 'Stub project', 'playbook': 'ping.yml', 'name': 'Stub Job Template', 'limit': '', 'inventory': 'Stub Inventory', 'id': 42, 'hosts': {}, 'friendly_name': 'Job', 'finished': False, 'credential': 'Stub credential', 'created_by': 'admin'}
