automatics_ai.automatics.workflow_info (2.1.2) — module

Install collection

Install with ansible-galaxy collection install automatics_ai.automatics:==2.1.2

Add to requirements.yml

  collections:
    - name: automatics_ai.automatics
      version: 2.1.2

Description

Gathers information on automatics workflows

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather basic information on all automatics workflows
  automatics_ai.automatics.workflow_info:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather detailed information on a specific automatics workflow
  automatics_ai.automatics.node_info:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    workflow_id: 251af40c-c3f9-4749-a23c-fb79ffd3a5de

Inputs

    
hostname:
    description:
    - Hostname of the automatics server.
    required: true
    type: str

workflow:
    description:
    - workflow in automatics to select for the operation (name matching)
    required: false
    type: str

auth_token:
    description:
    - automatics authentication bearer token returned from automatics_login module
    required: true
    type: str

workflow_id:
    description:
    - workflow in automatics to select for the operation (id matching)
    required: false
    type: str

validate_certs:
    default: true
    description:
    - Verify the https certificate of the automatics server.
    required: false
    type: bool

Outputs

info:
  description: Information on given automatics nodes
  returned: with workflow_id param
  sample:
    description: Start one or more SAP systems including all components
    enabled: true
    filters:
    - entity: system
      field: type
      value: sap
    group: SAP Operation/SAP Start/SAP System
    icon: fluent:calendar-checkmark-20-regular
    id: 251af40c-c3f9-4749-a23c-fb79ffd3a5de
    name: SAP System Start
    origin: automatics
    parameters:
    - aggregation: true
      default: '1'
      hidden: true
      label: Client ID
      multi_valued: false
      name: ClientID
      origin: automatics
      regex: ^\d+$
      required: true
      type: client
    - aggregation: true
      hidden: true
      label: System ID
      multi_valued: false
      name: SystemID
      origin: automatics
      regex: ^\d+$
      required: true
      type: system
    - aggregation: true
      default: '0'
      hidden: false
      label: Execution Delay
      multi_valued: false
      name: ExecutionDelay
      origin: automatics
      regex: ^\d+$
      required: false
      type: timespan
    - aggregation: true
      default: true
      hidden: false
      label: Include Database components
      multi_valued: false
      name: IncludeDatabase
      origin: automatics
      required: true
      type: bool
      value_list_delimiter: ','
    - aggregation: true
      default: true
      hidden: false
      label: Include Start of Webdispatcher
      multi_valued: false
      name: IncludeWebdispatcher
      origin: automatics
      required: true
      type: bool
      value_list_delimiter: ','
    - aggregation: true
      default: '21600'
      hidden: true
      label: Workflow Timeout
      multi_valued: false
      name: WorkflowTimeout
      origin: automatics
      regex: ^\d+$
      required: false
      type: timespan
    - aggregation: true
      hidden: false
      label: Comment
      multi_valued: false
      name: Comment
      origin: automatics
      required: false
      type: string
    - aggregation: true
      default: '[]'
      hidden: false
      label: Additional Email Recipients
      multi_valued: false
      name: AdditionalEmailRecipients
      origin: automatics
      required: false
      type: email_list
    project: Workflows
    validation: 6cf7f4b2-256f-4c61-bb90-01439ec1cacf
    validation_enabled: true
    wizard_selection_type: systems
    workflow_type: default
  type: dict
workflows:
  description: Information on given automatics nodes
  elements: dict
  returned: without workflow_id param
  sample:
  - description: Start one or more SAP systems including all components
    enabled: true
    filters:
    - entity: system
      field: type
      value: sap
    group: SAP Operation/SAP Start/SAP System
    icon: fluent:calendar-checkmark-20-regular
    id: 251af40c-c3f9-4749-a23c-fb79ffd3a5de
    name: SAP System Start
    origin: automatics
    project: Workflows
    unapplicable: false
    unauthorized: false
    unlicensed: false
    validation: 6cf7f4b2-256f-4c61-bb90-01439ec1cacf
    validation_enabled: true
    wizard_selection_type: systems
    workflow_type: default
  - description: Stop one or more SAP systems including all components
    enabled: true
    filters:
    - entity: system
      field: type
      value: sap
    group: SAP Operation/SAP Stop/SAP System
    icon: fluent:calendar-cancel-20-regular
    id: 768145ec-fb4f-4d0c-9b88-fd0634c9b8d1
    name: SAP System Stop
    origin: automatics
    project: Workflows
    unapplicable: false
    unauthorized: false
    unlicensed: false
    validation: 6cf7f4b2-256f-4c61-bb90-01439ec1cacf
    validation_enabled: true
    wizard_selection_type: systems
    workflow_type: default
  type: list