ansible.builtin.snow_record (v2.8.20) — module

Create/Delete/Update records in ServiceNow

| "added in version" 2.5 of ansible.builtin"

Authors: Tim Rightnour (@garbled1)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

Creates/Deletes/Updates a single record in ServiceNow


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete the record we just made
  snow_record:
    username: admin
    password: xxxxxxx
    instance: dev99999
    state: absent
    number: "{{new_incident['record']['number']}}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete a non-existant record
  snow_record:
    username: ansible_test
    password: my_password
    instance: dev99999
    state: absent
    number: 9872354
  failed_when: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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."
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
data:
    description:
    - key, value pairs of data to load into the record. See Examples. Required for C(state:present)

state:
    choices:
    - present
    - absent
    description:
    - If C(present) is supplied with a C(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.  C(absent) will delete a record.
    required: true

table:
    default: incident
    description:
    - Table to query for records
    required: false

number:
    description:
    - Record number to update. Required for C(state:absent)
    required: false

instance:
    description:
    - The service now instance name
    required: true

password:
    description:
    - Password for username
    required: true

username:
    description:
    - User to connect to ServiceNow as
    required: true

attachment:
    description:
    - Attach a file to the record
    required: false

lookup_field:
    default: number
    description:
    - Changes the field that C(number) uses to find records
    required: false

Outputs

attached_file:
  description: Details of the file that was attached via C(attachment)
  returned: when supported
  type: dict
record:
  description: Record data from Service Now
  returned: when supported
  type: dict