Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/turbot/steampipe-plugin-servicenow
Use SQL to instantly query ServiceNow CMDB CI services, servers, incidents, objects & more. Open source CLI. No DB required.
https://github.com/turbot/steampipe-plugin-servicenow
backup etl hacktoberfest postgresql postgresql-fdw servicenow servicenow-api sql sqlite steampipe steampipe-plugin zero-etl
Last synced: 8 days ago
JSON representation
Use SQL to instantly query ServiceNow CMDB CI services, servers, incidents, objects & more. Open source CLI. No DB required.
- Host: GitHub
- URL: https://github.com/turbot/steampipe-plugin-servicenow
- Owner: turbot
- License: apache-2.0
- Created: 2023-02-24T01:42:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T13:56:17.000Z (7 months ago)
- Last Synced: 2024-04-14T10:44:11.431Z (7 months ago)
- Topics: backup, etl, hacktoberfest, postgresql, postgresql-fdw, servicenow, servicenow-api, sql, sqlite, steampipe, steampipe-plugin, zero-etl
- Language: Go
- Homepage: https://hub.steampipe.io/plugins/turbot/servicenow
- Size: 384 KB
- Stars: 4
- Watchers: 8
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ServiceNow Plugin for Steampipe
Use SQL to query sys_user, cmdb_ci, incident and more from ServiceNow.
- **[Get started →](https://hub.steampipe.io/plugins/turbot/servicenow)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/turbot/servicenow/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/turbot/steampipe-plugin-servicenow/issues)
## Quick start
### Install
Download and install the latest Steampipe plugin:
```bash
steampipe plugin install servicenow
```
Configure your [credentials](https://hub.steampipe.io/plugins/turbot/servicenow#credentials) and [config file](https://hub.steampipe.io/plugins/turbot/servicenow#configuration).
Configure your account details in `~/.steampipe/config/servicenow.spc`:
```hcl
connection "servicenow" {
plugin = "servicenow"
# Your ServiceNow instance URL
instance_url = "https://.service-now.com"
# Authentication information
username = "john.hill"
password = "j0t3-$j@H3"
}
```
Or through environment variables:
```sh
export SERVICENOW_INSTANCE_URL=https://.service-now.com
export SERVICENOW_USERNAME=john.hill
export SERVICENOW_PASSWORD=j0t3-$j@H3
```
Run steampipe:
```shell
steampipe query
```
List new incidents on your ServiceNow instance:
```sql
select
number,
short_description,
category,
priority
from
servicenow_incident
where
state = 1;
```
```
+------------+---------------------------------------+----------+----------+
| number | short_description | category | priority |
+------------+---------------------------------------+----------+----------+
| INC0000039 | Trouble getting to Oregon mail server | network | 5 |
| INC0000046 | Can't access SFA software | software | 3 |
| INC0009001 | Unable to post content on a Wiki page | inquiry | 3 |
| INC0000057 | Performance problems with wifi | inquiry | 5 |
| INC0009005 | Email server is down. | software | 1 |
| INC0007002 | Need access to the common drive. | inquiry | 4 |
+------------+---------------------------------------+----------+----------+
```
## Engines
This plugin is available for the following engines:
| Engine | Description
|---------------|------------------------------------------
| [Steampipe](https://steampipe.io/docs) | The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
| [Postgres FDW](https://steampipe.io/docs/steampipe_postgres/overview) | Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
| [SQLite Extension](https://steampipe.io/docs//steampipe_sqlite/overview) | Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
| [Export](https://steampipe.io/docs/steampipe_export/overview) | Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
| [Turbot Pipes](https://turbot.com/pipes/docs) | Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.
## Developing
Prerequisites:
- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)
Clone:
```sh
git clone https://github.com/turbot/steampipe-plugin-servicenow.git
cd steampipe-plugin-servicenow
```
Build, which automatically installs the new version to your `~/.steampipe/plugins` directory:
```
make
```
Configure the plugin:
```
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/servicenow.spc
```
Try it!
```
steampipe query
> .inspect servicenow
```
Further reading:
- [Writing plugins](https://steampipe.io/docs/develop/writing-plugins)
- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
## Open Source & Contributing
This repository is published under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) (source code) and [CC BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/2.0/) (docs) licenses. Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
[Steampipe](https://steampipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).
## Get Involved
**[Join #steampipe on Slack →](https://turbot.com/community/join)**
Want to help but don't know where to start? Pick up one of the `help wanted` issues:
- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
- [ServiceNow Plugin](https://github.com/turbot/steampipe-plugin-servicenow/labels/help%20wanted)