servicenow.servicenow.snow_record – Manage records in ServiceNow

Note

This plugin is part of the servicenow.servicenow collection (version 1.0.4).

To install it use: ansible-galaxy collection install servicenow.servicenow.

To use it in a playbook, specify: servicenow.servicenow.snow_record.

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

Creates, deletes and updates a single record in ServiceNow.

Requirements

The below requirements are needed on the host that executes this module.

python pysnow (pysnow)

Parameters

Parameter	Choices/Defaults	Comments
attachment string		Attach a file to the record.
client_id string		Client ID generated by ServiceNow.
client_secret string		Client Secret associated with client id.
data dictionary		key, value pairs of data to load into the record. See Examples. Required for `state:present`.
display_value boolean	no ← yes	sysparm_display_value
exclude_reference_link boolean	no ← yes	sysparm_exclude_reference_link
host string		The ServiceNow hostname. This value is FQDN for ServiceNow host. If the value is not specified in the task, the value of environment variable `SN_HOST` will be used instead. Mutually exclusive with `instance`.
instance string		The ServiceNow instance name, without the domain, service-now.com. If the value is not specified in the task, the value of environment variable `SN_INSTANCE` will be used instead.
lookup_field string	Default: "number"	Changes the field that `number` uses to find records.
number string		Record number to update. Required for `state:absent`.
password string		Password for username. Required whether using Basic or OAuth authentication. If the value is not specified in the task, the value of environment variable `SN_PASSWORD` will be used instead.
state string / required	present absent	If `present` is supplied with a `number` argument, the module will attempt to update the record with the supplied data. If no such record exists, a new one will be created. `absent` will delete a record.
suppress_pagination_header boolean	no ← yes	sysparm_suppress_pagination_header
table string	Default: "incident"	Table to query for records.
username string		Name of user for connection to ServiceNow. Required whether using Basic or OAuth authentication. If the value is not specified in the task, the value of environment variable `SN_USERNAME` will be used instead.

Examples

- name: Grab a user record
  servicenow.servicenow.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
  servicenow.servicenow.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
  servicenow.servicenow.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: Create an incident using host instead of instance
  servicenow.servicenow.snow_record:
    username: ansible_test
    password: my_password
    host: dev99999.mycustom.domain.com
    state: present
    data:
      short_description: "This is a test incident opened by Ansible"
      priority: 2

- name: Delete the record we just made
  servicenow.servicenow.snow_record:
    username: admin
    password: xxxxxxx
    instance: dev99999
    state: absent
    number: "{{new_incident['record']['number']}}"

- name: Delete a non-existant record
  servicenow.servicenow.snow_record:
    username: ansible_test
    password: my_password
    instance: dev99999
    state: absent
    number: 9872354
  failed_when: false

- name: Update an incident
  servicenow.servicenow.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
  servicenow.servicenow.snow_record:
    username: ansible_test
    password: my_password
    instance: dev99999
    state: present
    number: INC0000055
    attachment: README.md
  tags: attach

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
attached_file dictionary	when supported	Details of the file that was attached via `attachment`
record dictionary	when supported	Record data from Service Now

Authors

Tim Rightnour (@garbled1)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/servicenow/servicenow/snow_record_module.html