snow_record – Управление записями в ServiceNow
Новое в версии 2.5.
Описание
- Создаёт, удаляет и обновляет отдельную запись в ServiceNow.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- python pysnow (pysnow)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attachment строка | Прикрепить файл к записи. | |
| client_id строка добавлен в 2.9 | Идентификатор клиента, сгенерированный ServiceNow. | |
| client_secret строка добавлен в 2.9 | Секретный ключ клиента, связанный с идентификатором клиента. | |
| data словарь | Ключ-значение данных для загрузки в запись. См. Примеры. Требуется для state:present. | |
| instance строка | Имя экземпляра ServiceNow без домена, service-now.com. Если значение не указано в задаче, используется значение переменной окружения SN_INSTANCE. Поддержка переменных окружения добавлена в Ansible 2.9. | |
| lookup_field строка | По умолчанию: "number" | Изменяет поле, которое number использует для поиска записей. |
| number строка | Номер записи для обновления. Требуется для state:absent. | |
| password строка | Пароль для имени пользователя. Требуется при использовании аутентификации Basic или OAuth. Если значение не указано в задаче, используется значение переменной окружения SN_PASSWORD. Поддержка переменных окружения добавлена в Ansible 2.9. | |
| state строка / обязательно |
| Если present предоставлен с аргументом number, модуль попытается обновить запись с предоставленными данными.Если такая запись не существует, будет создана новая. absent удалит запись. |
| table строка | По умолчанию: "incident" | Таблица для запроса записей. |
| username строка | Имя пользователя для подключения к ServiceNow. Требуется при использовании аутентификации Basic или OAuth. Если значение не указано в задаче, используется значение переменной окружения SN_USERNAME. Поддержка переменных окружения добавлена в Ansible 2.9. |
Примеры
- name: Grab a user record
snow_record:
username: ansible_test
password: my_password
instance: dev99999
state: present
number: 62826bf03710200044e0bfc8bcbe5df1
table: sys_user
lookup_field: sys_id
- name: Grab a user record using OAuth
snow_record:
username: ansible_test
password: my_password
client_id: "1234567890abcdef1234567890abcdef"
client_secret: "Password1!"
instance: dev99999
state: present
number: 62826bf03710200044e0bfc8bcbe5df1
table: sys_user
lookup_field: sys_id
- name: Create an incident
snow_record:
username: ansible_test
password: my_password
instance: dev99999
state: present
data:
short_description: "This is a test incident opened by Ansible"
severity: 3
priority: 2
register: new_incident
- name: Delete the record we just made
snow_record:
username: admin
password: xxxxxxx
instance: dev99999
state: absent
number: "{{new_incident['record']['number']}}"
- name: Delete a non-existant record
snow_record:
username: ansible_test
password: my_password
instance: dev99999
state: absent
number: 9872354
failed_when: false
- name: Update an incident
snow_record:
username: ansible_test
password: my_password
instance: dev99999
state: present
number: INC0000055
data:
work_notes : "Been working all day on this thing."
- name: Attach a file to an incident
snow_record:
username: ansible_test
password: my_password
instance: dev99999
state: present
number: INC0000055
attachment: README.md
tags: attach
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| attached_file словарь | при поддержке | Подробная информация о файле, прикреплённом с помощью attachment
|
| record словарь | при поддержке | Данные записи из Service Now |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Tim Rightnour (@garbled1)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/snow_record_module.html