VeloCloud SDWAN collector SP (velocloud-sdwan-collect) installation is similar to any other SP installation and can be done through DCF module manager and also through controller.

Related package will be available in DCF module repository by default:

Example: <DCF-Install>/Tools/Module-Repository/velocloud-sdwan-collect-1.0.pkg

Installation via DCF REST API:

Parameters:
  • host - host where dcf is running.

  • port - port using which we can access dcf.

  • block-name - velocloud-sdwan.

  • block-id - id of the block returned by the provision call.

Provision: To create a new velocloud collect block send the provision call via HTTP POST url: POST: https://{{host}}:{{port}}/dcc/v1/catalog/blocks/{{block-name}}/provision

Sample response: Note that the block-id as it would be used in the subsequent calls.
{
    "blockID": "velocloud-sdwan",
    "message": "Block successfully deployed",
    "time": "2019-04-05 21:54:11.976683",
    "instanceId": "velocloud-sdwan2326aa8e-f0e6-4986-856e-7a438f4db23a",
    "params": {
        "velocloud-sdwan": {
            "collect": {
                "collectormode": "veloclouddiscovery"
            },
            "velocloud": {
                "host": [
                    {
                        "hostname": "localhost",
                        "username": "admin",
                        "password": "{1B414DCCE74DCAF290CBCBD9AE61211A855201DD60FA6C286617522A2B0F55E7F76E7D87AFA37FC8397DA42B751232A4}",
                        "port": "443",
                        "protocol": "https"
                    }
                ]
            },
            "kafka": {
                "cluster": {
                    "node": [
                        {
                            "host": "localhost",
                            "port": "9092"
                        }
                    ],
                    "topic": "default-topic",
                    "auth": "true",
                    "username": "admin",
                    "password": "{86929A3BEFEC196E5391B202FBE5736D1881D62A685BBFB4A54D2BF17E8B0790251F438D57118BE290650D207B22FEC8}"
                }
            },
            "collection_interval": "90",
            "runOnce_timeout": "3600"
        }
    }
}

Set config: Use the response from the provision call as a template for setting the velocloud block config in the POST call to set config. Do note that you can use this call to configure the collector in either discovery or monitoring mode. Make sure to correctly populate all the relevant fields before you send the call.

URL: https://{{host}}:{{port}}/dcc/v1/runtime/blocks/{{block-id}}/config/set

Sample post content:
{
        "velocloud-sdwan": {
            "collect": {
                "collectormode": "veloclouddiscovery"
            },
            "velocloud": {
                "host": [
                    {
                        "hostname": "<ip address>",
                        "username": “<username>”,
                        "password": "<password>",
                        "port": "443",
                        "protocol": "https"
                    }
                ]
            },
            "kafka": {
                "cluster": {
                    "node": [
                        {
                            "host": "<kafka-hostname>",
                            "port": "<kafka-port>"
                        }
                    ],
                    "topic": "<kafka-topic>",
                    "auth": "true",
                    "username": "<kafka-username>",
                    "password": "<kafka-password>"
                }
            },
            "collection_interval": "90"
        }
    }

Start/Stop/Restart: To start, stop and restart the collector, use the following REST calls:

Start url: POST: https://{{host}}:{{port}}/dcc/v1/runtime/blocks/{{block-id}}/service/start

Stop url: POST: https://{{host}}:{{port}}/dcc/v1/runtime/blocks/{{block-id}}/service/stop

Restart url: POST: https://{{host}}:{{port}}/dcc/v1/runtime/blocks/{{block-id}}/service/restart

Delete: To Delete the block, use the following DEL API:

URL: DEL: https://{{host}}:{{port}}/dcc/v1/catalog/blocks/{{block-id}}

Installation via CLI: Sample Installation questions and output :
Required dependencies, in processing order:
   [1]   java '8.0.202' v8.0.202
   [2]   module-manager '1.13u1' v1.13u1
   [3] I collector-manager 'velocloud-sdwan-collect' (none) => v5.10u1
   [4] I kafka-connector 'velocloud-sdwan-collect' (none) => v1.0u2
   [5] I stream-collector 'velocloud-sdwan-collect' (none) => v1.4u2
   [6] I velocloud-sdwan-collect 'velocloud-sdwan-collect' (none) => v1.1
> 2 not modified, 4 to install
> 32.7 MB space required / 37.5 GB available
 ? Enter the step to modify, 'yes' to accept them, or 'no' to cancel the operation [yes] > yes



Starting installation of Collector-Manager v5.10u1 from collector-manager-5.10u1-linux-x64...
 * Gathering information...  
 * 'Collector-Manager v5.10u1' will be registered with instance name 'velocloud-sdwan-collect'.
 * It will be installed in '/opt/DCF/Collecting/Collector-Manager/velocloud-sdwan-collect'.
 * Unpacking files...  
 * Installing files... 100%    
 * 60 files have been installed.
 * Finalizing installation...
 * Installing service 'collector-manager velocloud-sdwan-colle...  [ installed ]
Installation complete.

Starting installation of Kafka-Connector v1.0u2 from kafka-connector-1.0u2-linux-x64...
 * Gathering information...  
 * 'Kafka-Connector v1.0u2' will be registered with instance name 'velocloud-sdwan-collect'.
 * It will be installed in '/opt/DCF/Collecting/Kafka-Connector/velocloud-sdwan-collect'.
 * Unpacking files...  
 * Installing files... 100%    
 * 17 files have been installed.
 * Finalizing installation...
Installation complete.

Starting installation of Stream-Collector v1.4u2 from stream-collector-1.4u2-linux-x64...
 * Gathering information...  
 * 'Stream-Collector v1.4u2' will be registered with instance name 'velocloud-sdwan-collect'.
 * It will be installed in '/opt/DCF/Collecting/Stream-Collector/velocloud-sdwan-collect'.
 * Unpacking files...  
 * Installing files... 100%    
 * 46 files have been installed.
 * Finalizing installation...
Installation complete.

Starting installation of velocloud-sdwan-collect v1.1 from velocloud-sdwan-collect-1.1...
 * Gathering information...  
 * 'velocloud-sdwan-collect v1.1' will be registered with instance name 'velocloud-sdwan-collect'.
 * It will be installed in '/opt/DCF/Block/velocloud-sdwan-collect/velocloud-sdwan-collect'.
 * Unpacking files...  
 * Installing files... 100%    
 * 28 files have been installed.
 * Finalizing installation...
   [1] velocloud discovery
   [2] velocloud monitoring
 ? VELOCLOUD Collection mode [1] > 1
 ? Do you want to configure velocloud host?  (yes/no) [y] > yes
 ? Hostname or IP address [localhost] > 1.1.1.1
 ? Username [admin] > 
 ? Password [•••••] > 
 ? Network Port [443] > 
   [1] http
   [2] https
 ? Protocol [2] > 2
 ? More entries? (yes/no) [n] > n
? Kafka Node Hostname or IP address [localhost] >
 ? Kafka Node Port Number [9092] >
 ? More entries? (yes/no) [n] >
 ? Kafka Topic name to publish Collected Data. [default-topic] >
   [1] Kafka server authentication disabled.
   [2] SASL_PLAINTEXT.
   [3] SASL_SSL.
   [4] SSL.

 If we select default option 2:-

 ? Kafka server authentication type. [2] > SASL_PLAINTEXT
 ? Kafka server username. [admin] >
 ? Kafka server password. [•••••] >
 ? Do you want to start the installed services now? (yes/no) [n] > n

If we select option 4 [SSL] :- 

? Kafka server authentication type. [2] > 4
 ? Location for Kafka Producer/Consumer TrustStore (Java TrustStore).   [../../../Tools/Webservice-Gateway/Default/conf/truststore] >
 ? Password for Kafka Producer/Consumer TrustStore (Java TrustStore). [•••••] >
 ? Location for Kafka Producer/Consumer KeyStore (Java KeyStore). [../../../Tools/Webservice-Gateway/Default/conf/clientkeystore] >
 ? Password for Kafka Producer/Consumer KeyStore (Java KeyStore). [•••••] >
 ? Password for KeyStore Key. [•••••] >


? Do you want to start the installed services now? (yes/no) [n] > yes