/ home / sap / sap.sap_operations / 1.25.0 / module / system

sap.sap_operations.system (1.25.0) — module

Manage SAP system

| "added in version" 1.0.0 of sap.sap_operations"

Authors: Ondra Machacek (@machacekondra), Kirill Satarin (@kksat)

Install collection

Install with ansible-galaxy collection install sap.sap_operations:==1.25.0

Add to requirements.yml

  collections:
    - name: sap.sap_operations
      version: 1.25.0

Description

Start and stop SAP system.

Requirements

python >= 3.6
suds >= 1.1.2

Usage examples

Scanned by Steampunk Spotter

- name: Use module with local socket on target machine
  sap.sap_operations.system:
    instance_number: "0"

Scanned by Steampunk Spotter

- name: Start system
  sap.sap_operations.system:
    username: "npladm"
    password: "secret123!"
    hostname: "sap.system.example.com"
    instance_number: "0"
    state: started

Scanned by Steampunk Spotter

- name: Stop system
  sap.sap_operations.system:
    username: "npladm"
    password: "secret123!"
    hostname: "sap.system.example.com"
    instance_number: "0"
    state: stopped

Inputs

    
name:
    choices:
    - ALL
    - SCS
    - DIALOG
    - ABAP
    - J2EE
    - TREX
    - ENQREP
    - HDB
    - ALLNOHDB
    - LEVEL
    default: ALL
    description:
    - I(name) name of the feature to be managed.
    type: str

wait:
    default: true
    description:
    - Wait for the operation to complete before returning.
    - If set to C(true), module will wait for service to start/ or stop.
    - If set to C(false), module will schedule the right operation and return immediately.
    type: bool

state:
    choices:
    - started
    - stopped
    default: started
    description:
    - State of the managed system.
    type: str

secure:
    choices:
    - strict
    - insecure
    - none
    default: strict
    description:
    - I(secure) specify if secure communication should be enforced.
    - By default system CA store is used. User can pass custom CA by I(ca_file) parameter.
    type: str

ca_file:
    description:
    - I(ca_file) use CA certificate to secure the communication. By default system CA
      store is used.
    type: str

hostname:
    description:
    - I(hostname) of the SAP system
    type: str

password:
    description:
    - I(password) of the SAP system
    type: str

username:
    description:
    - I(username) of the SAP system
    type: str

wait_timeout:
    default: 600
    description:
    - Wait timeout for the operation to complete before returning.
    type: int

instance_number:
    description:
    - The instance number of the managed service.
    - Must be between "0" and "99".
    required: true
    type: str

Outputs

system:
  description: System info
  returned: always
  sample:
    dispstatus: SAPControl-GREEN
    features: MESSAGESERVER|ENQUE,
    hostname: vhcalnplcs,
    httpPort: 50113,
    httpsPort: 50114,
    instanceNr: 1,
    startPriority: 1,
  type: dict

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also