Ansible/playbooks/schemas/patch_summary_v1.yml

# AIM public operation-data schema. Closed fields; no raw package-manager/module output.
type: object
properties:
  platform:
    type: string
    maxLength: 128
    enum:
      - windows
      - debian
      - redhat
  mode:
    type: string
    maxLength: 128
    enum:
      - apply
      - check
  evidence:
    type: string
    maxLength: 128
    enum:
      - package_snapshots
      - windows_update_result
      - preflight_reboot_state
  complete:
    type: boolean
  updates:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
          maxLength: 1024
        identifier:
          type: [string, 'null']
          maxLength: 1024
        architecture:
          type: [string, 'null']
          maxLength: 1024
        old_versions:
          type: array
          items:
            type: string
            maxLength: 1024
          maxItems: 100
        new_versions:
          type: array
          items:
            type: string
            maxLength: 1024
          maxItems: 100
        action:
          type: string
          maxLength: 128
          enum: [updated, installed, removed]
        kb:
          type: array
          items:
            type: string
            maxLength: 1024
          maxItems: 100
      required: [name, identifier, architecture, old_versions, new_versions, action, kb]
      additionalProperties: false
    maxItems: 20000
  updated_count:
    type: integer
    minimum: 0
  installed_count:
    type: integer
    minimum: 0
  removed_count:
    type: integer
    minimum: 0
  pending:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
          maxLength: 1024
        identifier:
          type: [string, 'null']
          maxLength: 1024
        kb:
          type: array
          items:
            type: string
            maxLength: 1024
          maxItems: 100
      required: [name, identifier, kb]
      additionalProperties: false
    maxItems: 20000
  failed_updates:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
          maxLength: 1024
        identifier:
          type: [string, 'null']
          maxLength: 1024
        native_code:
          type: [integer, 'null']
          minimum: 0
        native_code_hex:
          type: [string, 'null']
          maxLength: 32
        reason:
          type: string
          maxLength: 128
          enum: [update_failed, operation_in_progress, install_not_allowed, not_applicable, exclusive_install_conflict, self_update_in_progress, no_connection, timeout]
        message:
          type: string
          maxLength: 512
      required: [name, identifier, native_code, native_code_hex, reason, message]
      additionalProperties: false
    maxItems: 20000
  reboot_required:
    type: [boolean, 'null']
    description: Final observed/predicted pending reboot state after this run.
  reboot_required_before:
    type: boolean
    description: A pending reboot was detected before patching began.
  reboot_reasons_before:
    type: array
    description: Windows only. Native reboot sources reported by ansible.windows.win_reboot_info before patching.
    items:
      type: object
      properties:
        source:
          type: string
          maxLength: 128
        description:
          type: string
          maxLength: 512
      required: [source, description]
      additionalProperties: false
    maxItems: 32
  reboot_required_after:
    type: [boolean, 'null']
    description: Final pending reboot state; false after an AIM-performed successful reboot.
  reboot_performed:
    type: boolean
  reboot_deferred:
    type: boolean
    description: A reboot remains required because automatic reboot was disabled.
  reboot_delay_minutes:
    type: integer
    minimum: 0
    maximum: 1440
  blocked_reason:
    type: [string, 'null']
    maxLength: 128
    enum: [preexisting_reboot_required, update_failed, operation_in_progress, install_not_allowed, not_applicable, exclusive_install_conflict, self_update_in_progress, no_connection, timeout, cycle_limit_reached, null]
  rescan_after_reboot:
    type: boolean
    description: Windows only. True permits a newly discovered patch wave after an AIM-performed reboot.
  patch_cycles:
    type: integer
    minimum: 0
    maximum: 12
    description: Windows discovery/install cycles entered by this run.
  continuation_required:
    type: boolean
    description: Another operator-approved patch run is recommended or required to continue patching.
  remaining_updates_known:
    type: boolean
    description: True only when the report contains an authoritative post-wave discovery in pending.
required:
  - platform
  - mode
  - evidence
  - complete
  - updates
  - updated_count
  - installed_count
  - removed_count
  - pending
  - failed_updates
  - reboot_required
  - reboot_required_before
  - reboot_required_after
  - reboot_performed
  - reboot_deferred
  - reboot_delay_minutes
  - blocked_reason
additionalProperties: false