automatics_ai.automatics.sap_profile_parameter (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 profile parameters in automatics systems of type 'sap'

Usage examples

Scanned by Steampunk Spotter

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

- name: set single profile parameter on multiple systems in default profile in matching instance profiles
  automatics_sap_profile_parameter:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        sid: AUT
      - type: sap
        sid: AUS
      - type: sap-hana-db
        sid: HDB
    profile_type: all
    instance_profile_regex: ^[A-z][A-z0-9]{2}_D.+$
    parameters:
      - name: rdisp/max_wprun_time
        value: 3600

Scanned by Steampunk Spotter

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

- name: set multiple profile parametes on single system in all instance profiles
  automatics_sap_profile_parameter:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        sid: AUT
        client: client_1
    profile_type: instance
    parameters:
      - name: login/min_password_lng
        value: 16
      - name: login/min_password_letters
        value: 2
      - name: login/min_password_digits
        value: 2

Scanned by Steampunk Spotter

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

- name: delete single profile parametes on single system in default profile
  automatics_sap_profile_parameter:
    hostname: automatics.example.org
    auth_token: aW4iLCJlbWFpbCI6ImFkbWluIiw...
    validate_certs: false
    systems:
      - type: sap
        sid: AUT
        client: 21
    profile_type: default
    parameters:
      - name: rdisp/max_wprun_time
        value: ""

Inputs

    
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

parameters:
    description:
    - Parameters to set on matching profiles and systems
    elements: dict
    required: true
    suboptions:
      name:
        description:
        - Parameter name
        required: true
        type: str
      value:
        description:
        - Parameter value to be set
        required: true
        type: str
    type: list

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

profile_type:
    choices:
    - default
    - instance
    - all
    default: default
    description:
    - SAP profile types to apply the given parameters
    required: false
    type: str

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

instance_profile_regex:
    default: ^.+$
    description:
    - Regex for instance profile matching
    required: false
    type: str

Outputs

info:
  description: Information on all triggered automatics executions
  elements: dict
  returned: always
  sample:
  - comment: null
    date_ended: 1676372465
    date_started: 1676372444
    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'
      ParameterList:
        default: false
        label: Parameter List
        origin: automatics
        type: sap_param_list
        value: '[{ "profile_name": "DEFAULT", "parameter_name": "rdisp/max_wprun_time",
          "old_value": "", "new_value": "3600"}]'
      SystemID:
        default: false
        details:
          name: AUT
        label: System ID
        origin: automatics
        type: system
        value: '1056'
      WorkflowTimeout:
        default: true
        label: Workflow Timeout
        origin: automatics
        type: timespan
        value: '3600'
    runtime: 20.32
    status: succeeded
    user: ansible
    workflow:
      description: Set specific SAP profile parameters for systems
      id: 78b3241c-a86e-4108-a48d-b73e1898dcb9
      name: Set specific profile parameters
      origin: automatics
  type: list