Skip to main content

NetSpyGlass CLI

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nsgcli-2.2.8.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

nsgcli-2.2.8-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file nsgcli-2.2.8.tar.gz.

File metadata

  • Download URL: nsgcli-2.2.8.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for nsgcli-2.2.8.tar.gz
Algorithm Hash digest
SHA256 10d20eb1e52d74b1e0d524b70ce25d34dee13c354ff3abb3013a9ada3bc7bf0d
MD5 c8801c38e2f9393f35602b2a3e7d28c4
BLAKE2b-256 5dd6ce83f475c70d1d5e9a57d70f10e0c2e317aa1b9d03242f761bcd84fb7abe

See more details on using hashes here.

File details

Details for the file nsgcli-2.2.8-py3-none-any.whl.

File metadata

  • Download URL: nsgcli-2.2.8-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for nsgcli-2.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 2eefdf6acb1b56513f45fd9fc2d6e83ed07b5e86d8885532be2086f160315639
MD5 867bb9b4f58a541cf5b6309b20ada3aa
BLAKE2b-256 17f51377a3ce0cf6c4345af3a2a2aaf0444ce3c01710d25d29477e833725958f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page