Модуль community.sap_libs.sap_hostctrl_exec — модуль Ansible для выполнения SAPHostControl

Краткое описание

• Обеспечивает поддержку SAP Host Agent
• Дополнительные сведения о некоторых функциях см. здесь: https://help.sap.com/docs/host-agent/saphostcontrol-web-service-interface
• Если в качестве имени узла указано «localhost» и имя пользователя с паролем не заданы, модуль попытается использовать аутентификацию через локальный сокет Unix (она работает с повышением привилегий через «become»).

Параметры

Примечания

Примеры

- name: ListDatabases with custom host and port
  community.sap_libs.sap_hostctrl_exec:
    hostname: 192.168.8.15
    function: ListDatabases
    port: 1128

- name: ListInstances using local Unix socket (requires become)
  community.sap_libs.sap_hostctrl_exec:
    function: ListInstances
  become: true

- name: ListInstances using local Unix socket as SAP admin user and selector parameters
  community.sap_libs.sap_hostctrl_exec:
    function: ListInstances
    parameters:
      aSelector:
        aInstanceStatus: S-INSTALLED # S-INSTALLED | S-RUNNING | S-STOPPED | S-LAST
  become: true
  become_user: "{{ sap_sid | lower }}adm"

- name: StartInstance with authentication
  community.sap_libs.sap_hostctrl_exec:
    hostname: 192.168.8.15
    username: tstadm
    password: test1234
    function: StartInstance
    parameters:
      aInstance:
        mSid: 'TST'
        mSystemNumber: '01'
      aOptions:
        mTimeout: -1 # -1=synchronous, 0=async, >0=wait timeout in seconds
        mSoftTimeout: 0
        mOptions:
          - O-INSTANCE

- name: Synchronous StartDatabase using local Unix socket with arguments
  community.sap_libs.sap_hostctrl_exec:
    function: StartDatabase
    parameters:
      aArguments:
        item: "{{ dict_arguments | dict2items(key_name='mKey', value_name='mValue') }}"
      aOptions:
        mTimeout: -1
  vars:
    dict_arguments:
      Database/Name: SYSTEMDB@XDH
      Database/Type: hdb # hdb|ora|mss|db6|ada|sap|syb|ase|db2|max
      # Database/InstanceName: HDB00 # the following parameters are optional
      # Database/Host: mydbhost.example.com
      # Database/Username: SYSTEM
      # Database/Password: StarWarsFTW123!
  become: true

- name: Example of GetDatabaseStatus
  community.sap_libs.sap_hostctrl_exec:
    function: GetDatabaseStatus
    parameters:
      aArguments:
        item: "{{ dict_arguments | dict2items(key_name='mKey', value_name='mValue') }}"
  vars:
    dict_arguments:
      Database/Name: XDH
      Database/Type: hdb
  become: true

# Example from https://help.sap.com/docs/host-agent/saphostcontrol-web-service-interface/executeoperation
- name: Asynchronous ExecuteOperation
  community.sap_libs.sap_hostctrl_exec:
    function: ExecuteOperation
    parameters:
      aOperation: "sayhello"
      aArguments:
        item:
          mKey: "MY_NAME"
          mValue: "Sally"
  register: operation_say_hello
  become: true

- name: Check results of previous ExecuteOperation
  community.sap_libs.sap_hostctrl_exec:
    function: GetOperationResults
    parameters:
      aOperationID: "{{ operation_say_hello.out[0].mOperationID }}"
      aOptions:
        mTimeout: -1
  become: true

# Output of GetOperationResults for the above ExecuteOperation :
#
# changed: true
# error: ""
# msg: Succesful execution of: GetOperationResults
# out:
#   - mOperationID: "42010A3F050B1FD0B5A26EF66B9FA7B7"
#     mOperationResults:
#       item:
#         - mMessageKey: description
#           mMessageValue: Say hello
#         - mMessageKey: null
#           mMessageValue: "\"hello Sally\""
#         - mMessageKey: exitcode
#           mMessageValue: 0

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля: