The Ansible Collection for ServiceNow IT Service Management (ITSM) includes a variety of Ansible content to help automate the management of ServiceNow IT Service Management.
| Release | Status | Expected end of life |
|---|---|---|
| 2 | Maintained | TBA |
| 1 | Maintained (bug fixes only) | September 2023 |
This collection has been tested against following Ansible versions: >=2.9.10.
For collections that support Ansible 2.9, please ensure you update your network_os to use the
fully qualified collection name (for example, cisco.ios.ios).
Plugins and modules within a collection may be tested with only specific Ansible versions.
A collection may contain metadata that identifies these versions.
PEP440 is the schema used to describe the versions of Ansible.
This collection requires Python 2.7 or greater.
| Name | Description |
|---|---|
| servicenow.itsm.now | Inventory source for ServiceNow table records. |
| Name | Description |
|---|---|
| servicenow.itsm.api | Manage ServiceNow POST, PATCH and DELETE requests |
| servicenow.itsm.api_info | Manage ServiceNow GET requests |
| servicenow.itsm.attachment_info | a module that users can use to download attachment using sys_id |
| servicenow.itsm.attachment_upload | Upload attachment to the selected table |
| servicenow.itsm.change_request | Manage ServiceNow change requests |
| servicenow.itsm.change_request_info | List ServiceNow change requests |
| servicenow.itsm.change_request_task | Manage ServiceNow change request tasks |
| servicenow.itsm.change_request_task_info | List ServiceNow change request tasks |
| servicenow.itsm.configuration_item | Manage ServiceNow configuration items |
| servicenow.itsm.configuration_item_batch | Manage ServiceNow configuration items in batch mode |
| servicenow.itsm.configuration_item_info | List ServiceNow configuration item |
| servicenow.itsm.incident | Manage ServiceNow incidents |
| servicenow.itsm.incident_info | List ServiceNow incidents |
| servicenow.itsm.problem | Manage ServiceNow problems |
| servicenow.itsm.problem_info | List ServiceNow problems |
| servicenow.itsm.problem_task | Manage ServiceNow problem tasks |
| servicenow.itsm.problem_task_info | List ServiceNow problem tasks |
You can install the ServiceNow ITSM collection with the Ansible Galaxy CLI:
ansible-galaxy collection install servicenow.itsm
You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:
---
collections:
- name: servicenow.itsmYou can either call modules by their Fully Qualified Collection Namespace (FQCN), such as servicenow.itsm.incident_info, or you can call modules by their short name if you list the servicenow.itsm collection in the playbook's collections keyword:
TODO: INCIDENT_INFO module example.
- ServiceNow IT Service Management
- Ansible Using collections for more details.
We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the ServiceNow ITSM collection repository. See Contributing to Ansible-maintained collections for more details.
You can also join us on:
- IRC - the
#ansible-communityirc.libera.chat channel
See the Ansible Community Guide for details on contributing to Ansible.
See the CHANGELOG.rst
Assuming your (local) repository has set origin to your GitHub fork and this repository is added as upstream:
Prepare the release:
- Make sure your fork is up to date:
git checkout main && git pull && git fetch upstream && git merge upstream/main. - Run
ansible-playbook scripts/prepare_release.yml. The playbook tries to generate the next minor release automatically, but you can also set the version explicitly with--extra-vars "version=$VERSION". You will have to set the version explicitly when publishing a new major release. - Push the created release branch to your GitHub repo (
git push --set-upstream origin prepare_$VERSION_release) and open a pull request for the review.
Push the release:
- After the PR has been merged, make sure your fork is up to date:
git checkout main && git pull && git fetch upstream && git merge upstream/main. - Tag the release:
git tag -s $VERSION - Push the tag:
git push upstream $VERSION
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Community code of conduct
GNU General Public License v3.0 or later.
See COPYING to see the full text.