automatics_ai.automatics.system (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

Manages systems in automatics

Usage examples

Scanned by Steampunk Spotter

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

- name: Start single SAP-system with automatics
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        name: AUT
    state: started

Scanned by Steampunk Spotter

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

- name: Stop multiple SAP-systems with automatics
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        name: AUT
      - type: sap
        name: AUS
      - type: sap-hana-db
        name: HDB
    state: stopped

Scanned by Steampunk Spotter

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

- name: Restart multiple SAP-systems in different clients with automatics
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        name: AUT
        client: client_1
      - type: sap-hana-db
        name: DB1
        client: client_1
      - type: sap
        name: AUT
        client: client_2
      - type: sap-hana-db
        name: DB1
        client: 21
    state: restarted

Scanned by Steampunk Spotter

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

- name: Restart multiple SAP-systems including database and webdispatcher dependencies
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        name: AUT
      - type: sap
        name: AUS
    include_db_for_sap_systems: true
    include_wdp_for_sap_systems: true
    state: restarted

Scanned by Steampunk Spotter

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

- name: Restart multiple SAP-HANA-systems including SAP-system and webdispatcher dependencies
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap-hana-db
        name: DB1
      - type: sap-hana-db
        name: DB2
    include_sap_for_hana_systems: true
    include_wdp_for_hana_systems: true
    state: restarted

Scanned by Steampunk Spotter

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

- name: Stopping multiple systems of different type including all dependencies
  automatics_ai.automatics.system:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        name: AUT
      - type: sap
        name: AUS
      - type: sap-hana-db
        name: DB1
      - type: sap-hana-db
        name: DB2
      - type: sap-wdp
        name: WDP
    include_db_for_sap_systems: true
    include_wdp_for_sap_systems: true
    include_sap_for_hana_systems: true
    include_wdp_for_hana_systems: true
    state: stopped

Inputs

    
state:
    choices:
    - started
    - stopped
    - restarted
    description:
    - The desired state for the provided systems that automatics will ensure
    required: true
    type: str

systems:
    description:
    - systems in automatics to select for the operation (name matching)
    - dict containing 'type', 'name' and 'client' that must match the automatics system-type,
      name and client
    - for systems of type 'sap' and 'sap-hana-db', the 'name' equals the SAP SID
    - for systems of type 'sap-wdp', the 'name' equals <sapsid>@<node>
    elements: dict
    required: false
    suboptions:
      client:
        default: '1'
        description:
        - the client to which the system is assigned
        - can either be the client id or client name
        - default is client with id=1, what is the automatics default client
        required: false
        type: str
      name:
        description:
        - must match the automatics system name
        required: true
        type: str
      type:
        choices:
        - sap
        - sap-hana-db
        - sap-wdp
        description:
        - must match the automatics system-type
        required: true
        type: str
    type: list

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

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

system_ids:
    description:
    - systems in automatics to select for the operation (id matching)
    - must match the automatics system-id
    elements: int
    required: false
    type: list

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

execution_timeout:
    default: 120
    description:
    - Execution timeout in minutes for the triggered executions in automatics
    required: false
    type: int

include_db_for_sap_systems:
    default: false
    description:
    - whether database components should be included when applying the given state to
      a system of type 'sap'
    required: false
    type: bool

include_wdp_for_sap_systems:
    default: false
    description:
    - whether webdispatcher should be included when applying the given state to a system
      of type 'sap'
    required: false
    type: bool

include_sap_for_hana_systems:
    default: false
    description:
    - whether sap-systems should be included when applying the given state to a system
      of type 'sap-hana-db'
    required: false
    type: bool

include_wdp_for_hana_systems:
    default: false
    description:
    - whether webdispatcher should be included when applying the given state to a system
      of type 'sap-hana-db'
    required: false
    type: bool

Outputs

info:
  description: Information on all triggered automatics executions
  elements: dict
  returned: always
  sample:
  - comment: null
    date_ended: 1676039330
    date_started: 1676039108
    parameters:
      ClientID:
        default: false
        label: Client ID
        origin: automatics
        type: client
        value: '1'
      ExecutionDelay:
        default: true
        label: Execution Delay
        origin: automatics
        type: timespan
        value: '0'
      SystemID:
        default: false
        details:
          name: RD1
        label: System ID
        origin: automatics
        type: system
        value: '1035'
      WorkflowTimeout:
        default: true
        label: Workflow Timeout
        origin: automatics
        type: timespan
        value: '21600'
    runtime: 221.4
    status: succeeded
    user: ansible
    workflow:
      description: Start one or more SAP systems including all components
      id: 251af40c-c3f9-4749-a23c-fb79ffd3a5de
      name: SAP System Start
      origin: automatics
  type: list