Netskope Knowledge Portal

https://docs.netskope.com/en/
Admin
The Netskope Knowledge Portal provides comprehensive documentation and resources for Netskope's...
Tokens:1,705,764
Snippets:10,725
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example output for content install

Source: https://docs.netskope.com/en/upgrade-the-additional-appliance-packages

Example response when installing content version 56.1.0.94.

```bash
netskopesf> upgrade content install version 56.1.0.94
```

--------------------------------

### Run setup and start Cloud Exchange

Source: https://docs.netskope.com/en/upgrade-cloud-exchange

Execute the setup script and then launch Cloud Exchange.

```bash
sudo python3 ./setup
```

```bash
sudo ./start
```

--------------------------------

### MSIEXEC Install Command Example

Source: https://docs.netskope.com/en/deploy-client-on-windows-using-omnissa-workspace-one

Example of the MSIEXEC command with sample values. Use this as a reference when configuring the install command for your deployment.

```plaintext
msiexec /I NSClient.msi tenant=corp domain=goskope.com installmode=IDP enrollencryptiontoken=XXX /qn
```

--------------------------------

### MSIEXEC Install Command for IDP

Source: https://docs.netskope.com/en/deploy-client-on-windows-using-intune-with-win32-app

Example install command for Netskope Client when using IDP, with installmode=IDP, tenant, and domain parameters.

```shell
msiexec /I NSClient.msi installmode=IDP tenant=corp domain=eu.goskope.com /qn
```

--------------------------------

### Example output for threat-feed install

Source: https://docs.netskope.com/en/upgrade-the-additional-appliance-packages

Example response when installing threat-feed version 1.1052.

```bash
netskopesf> upgrade threat-feed install version 1.1052
```

--------------------------------

### Start Cloud Exchange services

Source: https://docs.netskope.com/en/cloud-exchange-kb-articles

Navigate to the Cloud Exchange installation directory and run this command to start all services.

```bash
./start
```

--------------------------------

### Example Request and Response for Starting CSA Scan

Source: https://docs.netskope.com/en/start-a-csa-scan

Shows a curl command to start a scan and the JSON response containing a 'scan_id' hash value, which is used to get the scan status. The response includes a 'data' object with the scan_id.

```bash
curl -X GET https://<tenant-URL>/api/v1/csa_scan?token=<token>&op=start&name=<policy_name>&scan_start_by=<name>
```

```json
{
   "status": "success",    
   "msg": "Policy scan has been submitted",    
   "data  {    
     "scan_id": "2e528976d8c01e115d8943519ab7b0f043ead317",            
   "data": [] 
    }
}
```

--------------------------------

### Example output for content list

Source: https://docs.netskope.com/en/upgrade-the-additional-appliance-packages

Example response from the 'upgrade content list' command showing an available version.

```bash
netskopesf> upgrade content list                 Available for download: 56.1.0.94
```

--------------------------------

### Example Get Policy Details Request

Source: https://docs.netskope.com/en/get-storage-scan-policy-details

Example GET request to retrieve details for the storage policy named 'HQ_storage'.

```http
GET 'https://<tenant-URL>/api/v1/storage_scan_policies/?token=<token>&op=detail&policy_name=HQ_storage'
```

--------------------------------

### Example msiexec command with prelogon user user1@prelogon.netskope.com

Source: https://docs.netskope.com/en/netskope-client-for-windows

Example command with a Client Configuration configured with Prelogon User user1@prelogon.netskope.com.

```bash
msiexec /I NSClient.msi host=addon-corp.goskope.com token=XXX enrollauthtoken=XXX enrollencryptiontoken=XXX mode=peruserconfig prelogonuser=user1@prelogon.netskope.com /qn
```

--------------------------------

### Enable Netskope Client via CLI

Source: https://docs.netskope.com/en/netskope-client-for-linux

Example CLI session showing how to start the Netskope Client CLI, enable the client, and quit. The output shows the CLI version and success message.

```bash
~$ nsclient
start process....
===== Netskope Client CLI,  Version: 200.200.0.100 =====
Copyright(c) 2022 Netskope, Inc. All Rights Reserved.
Please enter <help> for available commands.
Netskope> enable
Enabling Netskope Client...
Netskope Client enable success.
Netskope> quit
```

--------------------------------

### Get Anomaly API - GET curl example with response

Source: https://docs.netskope.com/en/using-the-rest-api-v2-uci-impact-endpoints

Fetches anomaly information using a GET request to the anomaly endpoint. The example includes the request and the JSON response containing anomaly details such as anomalyId, user, score, and source.

```bash
curl -kv -X GET 'https://<tenant-URL>/api/v2/incidents/anomalies/xxxxx 
-H 'Netskope-Api-Token: xxxxx' 
-H 'Content-Type: application/json' 

Response:
    {
      "anomalyId": "xxxxx",
      "user": "blah@sm.com",
      "time": 1677618382070,
      "score": 20,
      "activity": "ActivityForUciImpactAPI",
      "eventId": "event_id2",
      "anomalyCreatedTime": "2023-02-28T21:06:24Z",
      "source": "OKTA",
      "reason": "login failed in OKTA"
    }
```

--------------------------------

### Install and Enroll by Email ID

Source: https://docs.netskope.com/en/netskope-client-for-linux

Use this command to install and enroll the Netskope Client using an email address. Replace <tenant hostname>, <org key>, and <email address> with your actual values. Example: sudo ./STAgent.run -H abc.goskope.com -o abc123xyz -m user@example.org

```bash
sudo ./STAgent.run -H <tenant hostname> -o <org key> -m <email address>
```

```bash
STAgent.run {-H | --tenant-hostname tenant_hostname}            
             {-o | --orgkey orgKey}            
             {-m | --email email_address}             
             [-a | --enroll-auth-token enroll_authentication_token]          
             [-e | --enroll-encrypt-token enroll_encryption_token]            
             [-c | --cli]
Options:-H --tenant-hostname: Tenant hostname
        -o --orgkey: org key
        -m --email: User email
        -a --enroll-auth-token: enroll authentication token
        -e --enroll-encrypt-token: enroll encryption token
        -c --cli: This is a flag for CLI only mode and no value
                  When this argument is present, UI will not be installed
```

--------------------------------

### Sample CLI for silent installation with msiexec

Source: https://docs.netskope.com/en/deploy-the-netskope-client

Use this command to silently install the Netskope Client with parameters for host, token, tenant, domain, install mode, and enrollment tokens. Replace placeholders like <ver>, <addon URL>, <orgID>, <tenant-name>, <tenant-domain-name>, <auth token>, <encryption token>, and <user> with actual values. The command uses installmode=IDP and mode=peruserconfig.

```bash
msiexec /I C:NetskopeInstallerPkgnsclient-<ver>.msi host=<addon URL> token=<orgID> tenant=<tenant-name> domain=<tenant-domain-name> installmode=IDP mode=peruserconfig enrollauthtoken=<auth token> enrollencryptiontoken=<encryption token> prelogonuser=<user>@prelogon.netskope.com
```

--------------------------------

### GET /v1/config/certificate/status - Error response 404 (no certificate installed)

Source: https://docs.netskope.com/en/configuration-api

Error response (404 Not Found) when no certificate is installed.

```json
{
  "err_code": "00301",
  "message": "resource not found: failed to get certificate status"
}
```

--------------------------------

### Download and install Netskope Publisher

Source: https://docs.netskope.com/en/create-a-new-publisher

Run this command in the home directory to download and install the necessary components for the Publisher. This may take about 10 minutes.

```bash
curl https://s3-us-west-2.amazonaws.com/publisher.netskope.com/latest/generic/bootstrap.sh | sudo bash; sudo su - $USER; exit
```

--------------------------------

### Verify podman-compose version

Source: https://docs.netskope.com/en/cloud-exchange-system-requirements

Checks that podman-compose v1.5.0 is installed. Refer to the podman-compose installation guide if the command is not available.

```bash
sudo podman-compose version
```

--------------------------------

### Verify Podman version

Source: https://docs.netskope.com/en/cloud-exchange-system-requirements

Checks that Podman v5.4.0 is installed. Refer to the Podman installation guide if the command is not available.

```bash
sudo podman version
```

--------------------------------

### POST /v1/config/certificate/install - Example request

Source: https://docs.netskope.com/en/configuration-api

Installs a CA-signed certificate for the gateway. The certificate must match the key pair generated for the most recent CSR. The new certificate takes effect immediately without a restart.

```http
POST /v1/config/certificate/install HTTP/1.1
Host: <appliance_ip>:8443
Content-Type: application/json
{
  "certificate": "-----BEGIN CERTIFICATE-----..."
}
```

--------------------------------

### Example output for content download

Source: https://docs.netskope.com/en/upgrade-the-additional-appliance-packages

Example response after downloading content version 56.1.0.94.

```bash
netskopesf> upgrade content download version 56.1.0.94 successfully downloaded
56.1.0.94.
```

--------------------------------

### Install curl on AWS China Publisher

Source: https://docs.netskope.com/en/create-a-new-publisher

Updates package metadata and installs curl, required for downloading the China setup script.

```bash
sudo apt update && sudo apt install -y curl 
```
Tokens:
Raw