sap.sap_operations.ha_check_config_info (1.25.0) — module

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

Collect information about installed SAP instances on the host

SAP start framework is used to collect information and perform actions from host level

Requirements

• python >= 3.6
• pyrfc >= 2.7.0

Usage examples

Scanned by Steampunk Spotter

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

- name: Run ha_check_config_info
  sap.sap_operations.ha_check_config_info:
    instance_number: "00"

Inputs

    
ca_file:
    description:
    - I(ca_file) - path to file with CA certificate to secure the communication. if not
      provided system CA store is used.
    - Required if I(security) is set to C(custom)
    type: path

hostname:
    description:
    - I(hostname) of the SAP system, will be used to connect to SAP host agent web services
    - Parameters I(username) I(password) and I(hostname) should be provided together.
    type: str

password:
    description:
    - I(password) of the OS user that will connect to SAP host agent web services (sapadm,
      or <sid>adm, or any other user with necessary permissions
    - Parameters I(username) I(password) and I(hostname) should be provided together.
    type: str

security:
    choices:
    - system
    - custom
    - none
    default: system
    description:
    - Parameter I(security) specifies how secure communication should be enforced.
    - By default system CA (certification authority) store is used (parameter value is
      C(system)).
    - If custom CA (certification authority) has to be used, parameter I(ca_file) should
      be set to path to CA public certificate.
    - If set to C(none) https communication is possible, but server certificate will not
      be checked for trust.
    type: str

username:
    description:
    - I(username) of the OS user that will connect to SAP host agent web services (sapadm,
      or <sid>adm, or any other user with necessary permissions)
    - Parameters I(username) I(password) and I(hostname) should be provided together.
    type: str

instance_number:
    default: '00'
    description: Instance number
    required: false
    type: str

Outputs

ha_check_config_info:
  description: Result of HACheckConfig method execution on host with SAP HANA installed
  elements: dict
  returned: success
  sample:
  - category: SAPControl-SAP-CONFIGURATION
    comment: 0 ABAP instances detected
    description: Redundant ABAP instance configuration
    state: SAPControl-HA-SUCCESS
  - category: SAPControl-SAP-CONFIGURATION
    comment: 0 Java instances detected
    description: Redundant Java instance configuration
    state: SAPControl-HA-SUCCESS
  - category: SAPControl-SAP-CONFIGURATION
    comment: All Enqueue server separated from application server
    description: Enqueue separation
    state: SAPControl-HA-SUCCESS
  - category: SAPControl-SAP-CONFIGURATION
    comment: All MessageServer separated from application server
    description: MessageServer separation
    state: SAPControl-HA-SUCCESS
  type: list