install

You can install NetQ with a single command or you can perform the individual steps using multiple commands. Generally, using the single command option is strongly recommended. However, the individual commands can be useful for troubleshooting the installation process when it fails.

You can use these commands only after bootstrapping the physical server or VM. Refer to netq bootstrap.


netq install cluster activate-job

Activates a NetQ instance after an initial server cluster (master and two worker nodes) is configured and installed. Activation requires a configuration key that can be obtained from support.

Alternately, use netq install cluster full to perform this and all other steps of a NetQ installation with a single command.

Syntax

netq install cluster activate-job
    config-key <text-opta-key>

Required Arguments

ArgumentValueDescription
activate-jobNAActivate NetQ instance
config-key<text-opta-key>Use this unique key to activate NetQ

Options

None

Sample Usage

cumulus@switch:~$ netq install cluster activate-job config-key ju8Kl4IhZ3cucHJvZDEubmV0cPk3vW11bHVzbmV0d29ya3MuY29cB3ag
  • netq install cluster full

netq install cluster full

Installs the NetQ software for an on-premises, server cluster deployment. Run this command on your master node. You must have the hostname or IP address of the master node, two worker nodes, virtual IP address, and the NetQ software bundle to run the command.

Obtain the software release bundle from the NVIDIA Application Hub.

Syntax

netq install cluster full
    (interface <text-opta-ifname>|ip-addr <text-ip-addr> [<text-ipv6-addr>])
    bundle <text-bundle-url>
    [config-key <text-opta-key>]
    [pod-ip-range <text-pod-ip-range>]
    workers <text-worker-01> <text-worker-02>
    [workers-ipv6 <text-worker-ipv6-01> <text-worker-ipv6-02>] 
    cluster-vip <text-cluster-vip> 
    [s3-access-key <text-s3-access-key> s3-secret-key <text-s3-secret-key>]

Required Arguments

ArgumentValueDescription
interface<text-opta-ifname>Install a server cluster with a master node using this interface to communicate with the NetQ Agents on the worker nodes
ip-addr<text-ip-addr>,<text-ipv6-addr>Install a server cluster with a master node with this IPv4 or IPv6 address to communicate with the NetQ Agents on the worker nodes
bundle<text-bundle-url>Install the NetQ software bundle at this location; you must specify a full path
workers<text-worker-01> <text-worker-02>Install the worker nodes with these IPv4 addresses
cluster-vip<text-cluster-vip>Specify a virtual IP address from the same subnet used for your master and worker nodes

Options

OptionValueDescription
config-key<text-opta-key>Use this unique key to install the server cluster
pod-ip-range<text-pod-ip-range>Specify a range of IP addresses for the pod
workers-ipv6<text-worker-ipv6-01> <text-worker-ipv6-02>Install the worker nodes with these IPv6 addresses
s3-access-key<text-s3-access-key>AWS S3 access key ID
s3-secret-key<text-s3-secret-key>AWS S3 secret key ID

Sample Usage

cumulus@<hostname>:~$ netq install cluster full interface eth0 bundle /mnt/installables/NetQ-4.9.0.tgz workers 10.20.10.25 10.20.10.45 cluster-vip 10.20.10.254
  • netq install cluster activate-job

netq install cluster master-init

After adding worker nodes to your cluster, run this command on your master node to initialize the cluster.

Syntax

netq install cluster master-init

Required Arguments

ArgumentValueDescription
master-initNAInitialize the cluster master node

Options

None

Sample Usage

cumulus@<hostname>:~$ netq install cluster master-init
    Please run the following command on all worker nodes:
    netq install cluster worker-init c3NoLXJzYSBBQUFBQjNOemFDMXljMkVBQUFBREFRQUJBQUFCQVFDM2NjTTZPdVVUWWJ5c2Q3NlJ4SHdseHBsOHQ4N2VMRWVGR05LSWFWVnVNcy94OEE4RFNMQVhKOHVKRjVLUXBnVjdKM2lnMGJpL2hDMVhmSVVjU3l3ZmhvVDVZM3dQN1oySVZVT29ZTi8vR1lOek5nVlNocWZQMDNDRW0xNnNmSzVvUWRQTzQzRFhxQ3NjbndIT3dwZmhRYy9MWTU1a
  • netq install cluster worker-init

netq install cluster worker-init

After initializing the cluster on the master node, run this command on each worker node.

Syntax

netq install cluster worker-init 
    <text-ssh-key>

Required Arguments

ArgumentValueDescription
worker-initNAInitialize cluster worker node
NA<text-ssh-key>Public SSH key

Options

None

  • netq install cluster master-init

netq install opta activate-job

Activates the NetQ Collector software after you configure and install an initial server or server cluster (master and two worker nodes). Activation requires a configuration key that you can obtain from an email titled A new site has been added to your NVIDIA NetQ account (sent to your NetQ administrator).

Syntax

netq install opta activate-job
    config-key <text-opta-key>

Required Arguments

ArgumentValueDescription
activate-jobNAActivate NetQ collector software
config-key<text-opta-key>Use this unique key to activate NetQ

Options

None

Sample Usage

cumulus@switch:~$ netq install opta activate-job config-key ju8Kl4IhZ3cucHJvZDEubmV0cPk3vW11bHV9f3lk0d29ya3MuY29cB3ag
  • netq install opta cluster
  • netq install opta standalone

netq install opta cluster full

Installs the NetQ software for a cloud, server cluster deployment. You must have the hostname, IP address (or interface of the servers), a virtual IP address, the NetQ software bundle, and configuration key to run the command. You can also configure a proxy.

Obtain the software release bundle from the NVIDIA Application Hub.

Obtain the config-key from the email sent to your NetQ administrator titled A new site has been added to your NVIDIA NetQ account. You can also obtain the configuration key through the NetQ UI in the premises management configuration.

Syntax

netq install opta cluster full
    (interface <text-opta-ifname>|ip-addr <text-ip-addr>)
    bundle <text-bundle-url>
    config-key <text-opta-key>
    [pod-ip-range <text-pod-ip-range>]
    workers <text-worker-01> <text-worker-02>
    cluster-vip <text-cluster-vip>
    [proxy-host <text-proxy-host> proxy-port <text-proxy-port>]
    [s3-access-key <text-s3-access-key> s3-secret-key <text-s3-secret-key>]

Required Arguments

ArgumentValueDescription
interface<text-opta-ifname>Install a server cluster with a master node using this interface to communicate with the NetQ Agents on the worker nodes
ip-addr<text-ip-addr>Install a server cluster with a master node with this IP address to communicate with the NetQ Agents on the worker nodes
bundle<text-bundle-url>Install the NetQ software bundle at this location; you must specify a full path
config-key<text-opta-key>Use this unique key to activate the software
workers<text-worker-01> <text-worker-02>Install the worker nodes with these IP addresses
cluster-vip<text-cluster-vip>Specify a virtual IP address from the same subnet used for your master and worker nodes

Options

OptionValueDescription
proxy-host<text-proxy-host>Use the proxy server with this hostname or IP address instead of directly connecting to the VM; you must also specify a port
proxy-port<text-proxy-port>Use this port on the proxy server instead of directly connecting to the VM; you must also specify a proxy host
pod-ip-range<text-pod-ip-range>Specify a range of IP addresses for the pod
s3-access-key<text-s3-access-key>AWS S3 access key ID
s3-secret-key<text-s3-secret-key>AWS S3 secret key ID

Sample Usage

cumulus@<hostname>:~$ netq install opta cluster full interface en01 bundle /mnt/installables/NetQ-4.9.0.tgz config-key CI39fo5CZ3cucHJvZDEubmV0cS5jdW11bHVzbmVp6z8ma3MuY29tGLsD workers 10.20.10.25 10.20.10.45 cluster-vip 10.20.10.254
  • netq install opta activate-job

netq install opta standalone full

Installs the NetQ software on a single cloud server (VM). You must have the hostname, IP address (or interface of the server), the NetQ software bundle, and configuration key to run the command. You can also configure a proxy.

Obtain the software release bundle from the NVIDIA Application Hub.

Obtain the config-key from the email sent to your NetQ administrator titled A new site has been added to your NVIDIA NetQ account. You can also obtain the configuration key through the NetQ UI in the premises management configuration.

Syntax

netq install opta standalone full
    (interface <text-opta-ifname>|ip-addr <text-ip-addr>)
    bundle <text-bundle-url>
    config-key <text-opta-key>
    [pod-ip-range <text-pod-ip-range>]
    [proxy-host <text-proxy-host> proxy-port<text-proxy-port>]
    [s3-access-key <text-s3-access-key> s3-secret-key <text-s3-secret-key>]

Required Arguments

ArgumentValueDescription
interface<text-opta-ifname>Install NetQ on the server with this interface as the communication interface for the NetQ Agents on the monitored switches and hosts
ip-addr<text-ip-addr>Install NetQ on the server with this IP address to communicate with the NetQ Agents on the monitored switches and hosts
bundle<text-bundle-url>Install the NetQ software bundle at this location; you must specify a full path
config-key<text-opta-key>Use this unique key to activate the software

Options

OptionValueDescription
pod-ip-range<text-pod-ip-range>Specify a range of IP addresses for the pod
proxy-host<text-proxy-host>Use the proxy server with this hostname or IP address instead of directly connecting to the VM; you must also specify a port
proxy-port<text-proxy-port>Use this port on the proxy server instead of directly connecting to the VM; you must also specify a proxy host
s3-access-key<text-s3-access-key>AWS S3 access key ID
s3-secret-key<text-s3-secret-key>AWS S3 secret key ID

Sample Usage

cumulus@<hostname>:~$ netq install opta standalone full interface en01 bundle /mnt/installables/NetQ-4.9.0.tgz config-key CI39fo5CZ3cucHJvZDEubmV0cS5jdW11bHVzbmVp6z8ma3MuY29tGLsD
  • netq install opta activate-job

netq install patch

Installs a focused software fix using a compressed file package (rather than a full installation or upgrade). Run this command on the NetQ appliance or VM as appropriate.

Syntax

netq install patch
    <text-tarball-name>

Required Arguments

ArgumentValueDescription
NA<text-tarball-name>Install the software patch contained in the tarball at this location; you must specify a full path

Options

None

Sample Usage

cumulus@<hostname>:~$ netq install patch /mnt/installables/NetQ-4.0.0-patch.tgz
  • netq upgrade

netq install standalone activate-job

Activates a NetQ instance after you install the software. Activation requires a configuration key that you can obtain from support.

Alternately, use netq install standalone full to perform this and all other steps of a NetQ installation with a single command.

Syntax

netq install standalone activate-job
    config-key <text-opta-key>

Required Arguments

ArgumentValueDescription
activate-jobNAActivate NetQ instance
config-key<text-opta-key>Use this unique key to activate NetQ

Options

None

Sample Usage

cumulus@switch:~$ netq install standalone activate-job config-key ju8Kl4IhZ3cucHJvZDEubmV0cPk3vW11bHVzbmV0d29ya3MuY29cB3ag
  • netq install standalone full

netq install standalone full

Installs the NetQ software on the NetQ VM in an on-premises, single server deployment. You must have the hostname or IP address of the server, and the NetQ software bundle to run the command. A configuration key is optional.

Obtain the software release bundle from the NVIDIA Application Hub.

Syntax

netq install standalone full 
    (interface <text-opta-ifname>|ip-addr <text-ip-addr> [<text-ipv6-addr>]) 
    bundle <text-bundle-url> 
    [ipv6] 
    [config-key <text-opta-key>]
    [pod-ip-range <text-pod-ip-range>]
    [s3-access-key <text-s3-access-key> s3-secret-key <text-s3-secret-key>]

Required Arguments

ArgumentValueDescription
fullNAInstall a server with NetQ software, running all initialization and configuration commands automatically
interface<text-opta-ifname>Install NetQ on the server with this interface as the communication interface for the NetQ Agents on the monitored switches and hosts
ip-addr<text-ip-addr>,<text-ipv6-addr>Install NetQ on the server with this IPv4 or IPv6 address to communicate with the NetQ Agents on the monitored switches and hosts
bundle<text-bundle-url>Install the NetQ software bundle at this location; you must specify a full path

Options

OptionValueDescription
ipv6NAInstall NetQ using an IPv6 address
config-key<text-opta-key>Use this unique key to activate the software
pod-ip-range<text-pod-ip-range>Specify a range of IP addresses for the pod
s3-access-key<text-s3-access-key>AWS S3 access key ID
s3-secret-key<text-s3-secret-key>AWS S3 secret key ID

Sample Usage

cumulus@<hostname>:~$ netq install standalone full interface eth0 bundle /mnt/installables/NetQ-4.9.0.tgz
  • netq install standalone activate-job

netq install update-opta-ssl-setting

Replace or update the TSL/SSL settings on OPTA for agent-OPTA connection.

Syntax

netq install update-opta-ssl-setting 
    ssl-cert <text-ssl-cert-file> 
    ssl-key <text-ssl-key-file>

Required Arguments

ArgumentValueDescription
update-opta-ssl-settingNAUpdate the TLS/SSL settings on OPTA for agent-opta connection
ssl-cert<text-ssl-cert-filel>TLS/SSL certificate file absolute path
ssl-key<text-ssl-key-filel>TLS/SSL private key file absolute path

Options

None

None