community.sap_libs.sap_company модуль — Этот модуль будет управлять сущностями компании в среде SAP S4HANA

Примечание

Этот модуль является частью коллекции community.sap_libs (версия 1.4.2).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.sap_libs. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: community.sap_libs.sap_company.

Впервые появился в community.sap_libs 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Модуль community.sap_libs.sap_user зависит от библиотеки Python pyrfc (версия 2.4.0 и выше). В зависимости от используемой дистрибуции, вам может потребоваться установить дополнительные пакеты для их доступности.
Этот модуль будет использовать BAPI компании BAPI_COMPANY_CLONE и BAPI_COMPANY_DELETE для управления сущностями компаний.

Требования

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

pyrfc >= 2.4.0

Параметры

Параметр	Комментарии
город строка	Город, в котором расположена компания.
клиент строка	Номер клиента для подключения. Вы должны заключить значение в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"000"`
идентификатор_компании строка / обязательно	Идентификатор компании.
пароль_подключения строка / обязательно	Необходимый пароль для системы SAP.
имя_пользователя_подключения строка / обязательно	Необходимое имя пользователя для системы SAP.
страна строка	Код страны для компании. Например, `'DE'`.
e-mail строка	Общий адрес электронной почты.
хост строка / обязательно	Необходимый хост для системы SAP. Может быть полным доменным именем или IP-адресом.
название строка	Название компании.
название_2 строка	Дополнительное название компании.
почтовый_индекс строка	Почтовый индекс города.
состояние строка	Решение о том, что делать с компанией. Варианты: `"present"` ← (по умолчанию) `"absent"`
улица строка	Улица, на которой расположена компания.
номер_дома строка	Номер дома.
система строка	Номер системы SAP. Вы должны заключить значение в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"01"`
часовой_пояс строка	Часовой пояс.

Примечания

Примечание

Не поддерживает check_mode.

Примеры

- name: Create SAP Company
  community.sap_libs.sap_company:
    conn_username: 'DDIC'
    conn_password: 'HECtna2021#'
    host: 100.0.201.20
    sysnr: '01'
    client: '000'
    state: present
    company_id: "Comp_ID"
    name: "Test_comp"
    name_2: "LTD"
    country: "DE"
    time_zone: "UTC"
    city: "City"
    post_code: "12345"
    street: "test_street"
    street_no: "1"
    e_mail: "test@test.de"

# pass in a message and have changed true
- name: Delete SAP Company
  community.sap_libs.sap_company:
    conn_username: 'DDIC'
    conn_password: 'HECtna2021#'
    host: 100.0.201.20
    sysnr: '01'
    client: '000'
    state: absent
    company_id: "Comp_ID"
    name: "Test_comp"
    name_2: "LTD"
    country: "DE"
    time_zone: "UTC"
    city: "City"
    post_code: "12345"
    street: "test_street"
    street_no: "1"
    e_mail: "test@test.de"

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
msg строка	Небольшое описание выполнения. Возвращаемое значение: всегда Пример: `"Company address COMP_ID created"`
out список / элементы=словарь	Полное описание выполненных задач. Если это доступно. Возвращаемое значение: всегда Пример: `"{ \"RETURN\": [ { \"FIELD\": \"\", \"ID\": \"01\", \"LOG_MSG_NO\": \"000000\", \"LOG_NO\": \"\", \"MESSAGE\": \"Company address COMP_ID created\", \"MESSAGE_V1\": \"COMP_ID\", \"MESSAGE_V2\": \"\", \"MESSAGE_V3\": \"\", \"MESSAGE_V4\": \"\", \"NUMBER\": \"078\", \"PARAMETER\": \"\", \"ROW\": 0, \"SYSTEM\": \"\", \"TYPE\": \"S\" } ] } }"`

Ключ

Описание

msg

строка

Небольшое описание выполнения.

Возвращаемое значение: всегда

Пример: "Company address COMP_ID created"

out

список / элементы=словарь

Полное описание выполненных задач. Если это доступно.

Возвращаемое значение: всегда

Пример: "{ \"RETURN\": [ { \"FIELD\": \"\", \"ID\": \"01\", \"LOG_MSG_NO\": \"000000\", \"LOG_NO\": \"\", \"MESSAGE\": \"Company address COMP_ID created\", \"MESSAGE_V1\": \"COMP_ID\", \"MESSAGE_V2\": \"\", \"MESSAGE_V3\": \"\", \"MESSAGE_V4\": \"\", \"NUMBER\": \"078\", \"PARAMETER\": \"\", \"ROW\": 0, \"SYSTEM\": \"\", \"TYPE\": \"S\" } ] } }"

Авторы

Rainer Leber (@rainerleber)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_company_module.html