Overview

NextGen gateway facilitates the new feature called Zero-touch onboarding. This feature helps customers with easy onboarding. Zero-touch onboarding reduces the customer efforts like creating credentials, discovery profiles, and integrations. Using the simple YAML configuration files these are created automatically and onboard the customer.

Please refer OpsRamp’s Collector Bootstrap Tool for general guidelines on how to install and register NextGen gateway.

YAML Discovery Configuration

Following is the sample YAML configuration that we need to prepare before registering the gateway to the OpsRamp cloud.

discovery-config.yaml

Sample YAML definition file

---
gatewayprofile:
  name: Gateway Profile
  description: Management Profile for Gateway
  type: Gateway
discovery:
- type: snmp
  credentail:
    credentialType: SNMP
    name: SNMP Credentails
    description: SNMP Device Credentails
    transportType: HTTP
    timeoutMs: 15000
    spSecure: false
    port: 161
    snmpVersion: V2
    community: public
  discoveryProfile:
    name: SNMP Discovery Profile
    discoveryType: gateway
    discoveryProfileType: SNMP
    deviceType: ''
    credentialSet: SNMP Credentails
    ipDetails:
      discoveryType: IPRANGE
      ipRange: 172.26.1.18,172.26.1.19
    gatewayScheduleFlag: 'true'
    discoverySchedule:
      patternType: DAILY
      pattern: '1'
      startTime: '02'
    customParams:
      discUsingCdpFdpLldpEtc: 'true'
- type: VMWare
  credentail:
    credentialType: VMWARE
    description: VMWare Device Credentails
    name: VMWare Credentails
    timeoutMs: 15000
    secure: true
    port: 443
    userName: admin@user
    password: admin@1234
  integration:
    displayName: VMWare-172.25.0.13
    ipAddress: 172.25.0.13
    credentialSet: VMWare Credentails
    discoveryProfiles:
      policy:
        actions:
        - action: MANAGE DEVICE
        entityType: ALL
        matchType: ANY
        rules:
        - filterType: ANY_CLOUD_RESOURCE
      scanNow: true
      schedule:
        pattern: '1'
        patternType: DAILY
        startTime: 18
- type: VMWare
  credentail:
    credentialType: VMWARE
    description: VMWare Device Credentails
    name: VMWare Credentails
    timeoutMs: 15000
    secure: true
    port: 443
    userName: admin@user
    password: admin@1234
  integration:
    displayName: VMWare-172.25.0.12
    ipAddress: 172.25.0.12
    credentialSet: VMWare Credentails
    discoveryProfiles:
      policy:
        actions:
        - action: MANAGE DEVICE
        entityType: ALL
        matchType: ANY
        rules:
        - filterType: ANY_CLOUD_RESOURCE
      scanNow: true
      schedule:
        pattern: '1'
        patternType: DAILY
        startTime: 18

How to Specify Discovery Configuration ?

opsramp-collector-start tool is required for Zero-touch onboarding.
You can download the opsramp-collector-start tool from here, and how to use this tool can be found here.

Once the YAML configuration is completed, use the opsramp-collector-start tool to register the gateway to the OpsRamp cloud by providing the configuration file as input.

Syntax

Register through a direct connection:

opsramp-collector-start install --environment {Environment} –-url {OpsRamp Server URL} –-key {Gateway unique authentication token} --config {YAML Discovery Configuration File Path}

Register through the proxy without credentials:

opsramp-collector-start install --environment {Environment} –-url {OpsRamp Server URL} –-key {Gateway unique authentication token} --proxy-protocol {Proxy Protocol http/https} --proxy-ip {Proxy IP Address} --proxy-port {Proxy Port} --config {YAML Discovery Configuration File Path}

Register through proxy with credentials:

opsramp-collector-start install --environment {Environment} –-url {OpsRamp Server URL} –-key {Gateway unique authentication token} --proxy-protocol {Proxy Protocol http/https} --proxy-ip {Proxy IP Address} --proxy-port {Proxy Port} --proxy-username {Proxy Username} --proxy-password {Proxy Password}  --config {YAML Discovery Configuration File Path}

Example

opsramp-collector-start install --environment k8s --url gatewaytest.api.opsramp.net --key 06d49ab5-a589-44f2-a68b-ee35405d5701 --config discovery-config.yml