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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

Параметры

Параметр	Описание
city строка	Город, в котором находится компания.
client строка	Номер клиента для подключения. Значение необходимо заключать в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"000"`
company_id строка / обязательный	Идентификатор компании.
conn_password строка / обязательный	Пароль, необходимый для подключения к системе SAP.
conn_username строка / обязательный	Имя пользователя, необходимое для подключения к системе SAP.
country строка	Код страны компании. Например, `'DE'`.
e_mail строка	Общий адрес электронной почты.
host строка / обязательный	Имя хоста, необходимое для подключения к системе SAP. Может быть полным доменным именем (FQDN) или IP-адресом.
name строка	Название компании.
name_2 строка	Дополнительное название компании.
post_code строка	Почтовый индекс города.
state строка	Действие, которое необходимо выполнить с компанией. Варианты: `"present"` ← (по умолчанию) `"absent"`
street строка	Улица, на которой находится компания.
street_no строка	Номер дома.
sysnr строка	Номер системы SAP. Значение необходимо заключать в кавычки, чтобы сохранить ведущие нули. По умолчанию: `"01"`
time_zone строка	Часовой пояс.

Примечания

Примечание

Не поддерживает 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"

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

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

Ключ	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/sap_libs/sap_company_module.html