Skip to main content

NetSpyGlass Command Line Tools

this package installs Python module nsgcli and two command line scripts: nsgcli and nsgql that use it

Use script tools/build.sh to build and tools/upload.sh to push to pypi

Example of API call made by nsgcli to nsg-api service:

  • System status

    curl -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/v2/nsg/cluster/net/1/status
    
  • NSGQL

    curl -d '{"targets": [{"format":"table", "nsgql":"select count(key) from alerts"}]}' -X POST -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/v2/query/net/1/data/
    
  • NSGGROK

    Parse text with custom pattern

    nsggrok --pattern "hello world of %{WORD:world_name}" text "hello world of Grok"
    {
    "world_name": "Grok"
    }
    

    Parse syslog message with built-in patterns

    nsggrok log "<13>May 18 11:22:43 carrier sshd: SSHD_LOGIN_FAILED: Login failed for user 'root' from host '10.1.1.1'"
    {
    "sshUser": "root",
    "index": "labdcdev-syslog-short",
    "sshSrcIp": "10.1.1.1",
    "logText": "SSHD_LOGIN_FAILED: Login failed for user 'root' from host '10.1.1.1'",
    "prio": "13",
    "logSyslogSeverityName": "notice",
    "logSource": "carrier",
    "logSyslogText": "<13>May 18 11:22:43 carrier sshd: SSHD_LOGIN_FAILED: Login failed for user 'root' from host '10.1.1.1'",
    "logSyslogFacilityName": "user",
    "logTimestamp": "2021-05-18T11:22:43.000Z",
    "program": "sshd",
    "logSyslogPriority": 13,
    "timestamp": "May 18 11:22:43",
    "logSyslogFacilityCode": 1,
    "logSyslogSeverityCode": 5
    }
    
  • Meraki API call

curl -G -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/v2/nsg/cluster/net/1/exec/api --data-urlencode 'region=world' --data-urlencode 'url=https://api.meraki.com/api/v1/organizations/626563298157920259/devices' --data-urlencode 'method=GET' --data-urlencode 'args=gap-meraki'
  • Test connection to remote server
curl -G -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/v2/nsg/cluster/net/1/exec/connect --data-urlencode 'region=world' --data-urlencode 'args=10.210.24.112 9339 1000'
  • Set log level
curl -G -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/v2/nsg/cluster/net/1/exec/set_log_level --data-urlencode 'region=world' --data-urlencode 'args=tme-server-15v io.grpc DEBUG'
  • Send PING command to an agent
curl -L -H "X-NSG-Auth-API-Token:$NSG_API_TOKEN" $NSG_SERVICE_URL/apiv3/net/1/exec/ping/agent/vkhome?address=127.0.0.1

Metadata

Release files for nsgcli 2.2.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nsgcli 2.2.9
File Size Uploaded
nsgcli-2.2.9.tar.gz 35.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nsgcli 2.2.9
File Interpreter ABI Platform
nsgcli-2.2.9-py3-none-any.whl Python 3 none any Details

Total release size: 83.8 kB

Release files / nsgcli-2.2.9.tar.gz

Download URL nsgcli-2.2.9.tar.gz
Size 35.8 kB
Tags Source
SHA-256 checksum
How to use checksums
01d074a3ac09718e8c0fae1d6fa8598ff436affc43187edaad4b03920e4aeec7
BLAKE2b-256 checksum
How to use checksums
8b3c5d9079880af50cb968a0dff551ee57624d5dcf734d1f70c693258bd59997
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / nsgcli-2.2.9-py3-none-any.whl

Download URL nsgcli-2.2.9-py3-none-any.whl
Size 48.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
089f0ddc30608ae6694627c081b125d2b4fd3b5597ac7cc00b5336c559672c59
BLAKE2b-256 checksum
How to use checksums
5ac3b6439f0630e92578d2916bad20f60c45cb9d4ec3d4a6c9ca813e1736f608
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

2.2.10

2 release files

This release

2.2.9 This release

2 release files

2.2.8

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.2

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.21

2 release files

1.1.19

2 release files

1.1.18

2 release files

1.1.17

2 release files

1.1.16

2 release files

1.1.15

2 release files

1.1.14

2 release files

1.1.13

2 release files

1.1.12

2 release files

1.1.11

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.0.47

3 release files

1.0.45

2 release files

1.0.44

2 release files

1.0.42

2 release files

1.0.41

2 release files

1.0.40

2 release files

1.0.39

2 release files

1.0.38

2 release files

1.0.36

2 release files

1.0.31

2 release files

1.0.30

2 release files

1.0.29

2 release files

1.0.28

2 release files

1.0.26

2 release files

1.0.24

2 release files

1.0.23

2 release files

1.0.20

2 release files

1.0.19

2 release files

1.0.15

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page