NVIDIA NVOS User Manual for InfiniBand Switches v25.02.5002
NVIDIA Docs Hub Homepage  NVIDIA Networking  Networking Software  Switch Software  NVIDIA NVOS User Manual for InfiniBand Switches v25.02.5002  Cluster Applications Commands

On This Page

Cluster Applications Commands

nv show cluster apps

nv show cluster apps

Display the aggregated information of cluster apps

Syntax Description

N/A

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv show cluster  apps
Name            ID             Version                 Capabilities                 Components Version                                 Status  Reason  Additional Information          Summary
--------------  -------------  ----------------------  ---------------------------  -------------------------------------------------  ------  ------  ------------------------------  -------
nmx-controller  nmx-c-nvos     0.8.0_2024-11-27_11-25  sm, gfm, fib, gw-api         sm:2004.11.6, gfm:R570.52, fib-fe:0.8.1            ok              CONTROL_PLANE_STATE_CONFIGURED
nmx-telemetry   nmx-telemetry  0.8.3                   telemetry, gnmi aggregation  telemetry-collector:1.19.9, gnmi-aggregator:0.8.3  ok

REST API

GET https://<ip>/nvue_v1/cluster/apps

Related Commands

nv show cluster apps <app-name>

Notes

nv show cluster apps name

nv show cluster apps <app-name>

Display an specific cluster app.

Syntax Description

app-name

The name of the cluster app.

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv show cluster app nmx-controller 
                  operational                            
----------------  ---------------------------------------
app-id            nmx-c-nvos                             
app-ver           0.9.0_2025-01-11_09-51                 
capabilities      sm, gfm, fib, gw-api                   
components-ver    sm:2025.01.1, gfm:R570.90, fib-fe:0.9.0
status            not ok                                 
reason            GFM: UNINITIALIZED                     
addition-info     CONTROL_PLANE_STATE_UNCONFIGURED       
manager                                                  
  ca-certificate                                         
  certificate                                            
  encryption      disabled                               
  state           disabled

REST API

GET https://<ip>/nvue_v1/cluster/apps/{app-name}

Related Commands

nv show cluster apps <app-name>

Notes

nv show cluster apps installed

nv show cluster apps installed

Display the installed apps of cluster.

Syntax Description

N/A

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
Name            ID             Version                 Capabilities                                         Components Version                                               
--------------  -------------  ----------------------  ---------------------------------------------------  -----------------------------------------------------------------
nmx-controller  nmx-c-nvos     0.9.0_2025-01-11_09-51  sm, gfm, fib, gw-api                                 sm:2025.01.1, gfm:R570.90, fib-fe:0.9.0                          
nmx-telemetry   nmx-telemetry  0.9.1                   nvl telemetry, gnmi aggregation, syslog aggregation  nvl-telemetry:1.19.14, gnmi-aggregator:0.8.9, nmx-connector:0.8.9

REST API

GET https://<ip>/nvue_v1/cluster/apps/installed

Related Commands

nv show cluster apps running

Notes

nv show cluster apps running

nv show cluster apps running

Display the running apps of cluster.

Syntax Description

N/A

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv show cluster apps running
Name            Status  Reason              Additional Information          
--------------  ------  ------------------  --------------------------------
nmx-controller  not ok  GFM: UNINITIALIZED  CONTROL_PLANE_STATE_UNCONFIGURED
nmx-telemetry   ok

REST API

GET https://<ip>/nvue_v1/cluster/apps/running

Related Commands

nv show cluster apps installed

Notes

nv action start cluster apps

nv action start cluster apps <app-name>

Start an cluster app.

Syntax Description

app-name

The name of the cluster app.

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action start cluster apps nmx-controller 

REST API

POST https://<ip>/nvue_v1/cluster/apps/{app-name}

Related Commands

nv action stop cluster apps <app-name>

Notes

nv action stop cluster apps

nv action stop cluster apps <app-name>

Stop an cluster app.

Syntax Description

app-name

The name of the cluster app.

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action stop cluster apps nmx-controller 

REST API

POST https://<ip>/nvue_v1/cluster/apps/{app-name}

Related Commands

nv action start cluster apps <app-name>

Notes

nv show cluster apps log-level

nv show cluster apps <app-name> log-level

Display an cluster app's log-level.

Syntax Description

app-name

The name of the cluster app.

Default

N/A

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv show cluster apps nmx-controller log-level 
                operational                      
--------------  ---------------------------------
log-level       warn                  

REST API

GET https://<ip>/nvue_v1/cluster/apps/{app-name}/log-level

Related Commands

nv action update cluster apps <app-name> log-level <log-level>

nv action restore cluster apps <app-name> log-level

Notes

nv action update cluster apps log-level

nv action update cluster apps <app-name> log-level <log-level>

Change an cluster app's log-level.

Syntax Description

app-name

The name of the cluster app.

log-level

The new log-level, should be one of critical, debug, error, info, notice, warn

Default

log-level: info

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action update cluster apps nmx-controller log-level error 

REST API

POST https://<ip>/nvue_v1/cluster/apps/{app-name}/log-level

Related Commands

nv action restore cluster apps <app-name> log-level

Notes

nv action restore cluster apps log-level

nv action restore cluster apps <app-name> log-level

Restore an cluster app's log-level to default.

Syntax Description

app-name

The name of the cluster app.

Default

app-name

History

25.02.1884

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action restore cluster apps nmx-controller log-level

REST API

POST https://<ip>/nvue_v1/cluster/apps/{app-name}/log-level

Related Commands

nv action update cluster apps <app-name> log-level <log-level>

Notes

nv show cluster apps log-stream

nv show cluster apps <app-name> log-stream

Display log stream of a cluster application.

Syntax Description

app-name

The name of the cluster application

Default

N/A

History

25.02.4253

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action show cluster apps nmx-controller
                               operational
----------------   ----------------------------------------
protocol           rsyslog
remote-url         192.168.1.100:514

REST API

GET https://<ip>/nvue_v1/cluster/apps/[app-name]/log-stream

Related Commands

nv action update cluster apps <app-name> log-stream <protocol> <remote-url>

nv action restore cluster apps <app-name> log-stream

Notes

nv action update cluster apps log-stream

nv action update cluster apps <app-name> log-stream <protocol> <remote-url>

Update the log stream of a cluster application.

Syntax Description

app-name

The name of the cluster application

protocol

Log stream protocol

remote-url

Log stream remote URL

Default

N/A

History

25.02.4253

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action update cluster apps nmx-controller log-stream rsyslog 192.168.1.100:514

REST API

POST https://<ip>/nvue_v1/cluster/apps/[app-name]/log-stream

Related Commands

nv action restore cluster apps <app-name> log-stream

nv show cluster apps log-stream

Notes

  • Only one {protocol: remote-url} is allowed; the last configuration will take effect.

  • Protocols include rsyslog, elk, and splunk.

  • Supports rsyslog streaming via UDP, and elk, splunk via HTTP.

  • Remote-url format is [username[:password]@server:port[?query_string]].

    • Supports server in IPv4, IPv6, and hostname notation.

    • For rsyslog – server:port in remote-url is valid.

      Example: nv action update cluster apps nmx-controller log-stream rsyslog 192.168.1.100:514

    • For elk – [username[:password]]@server:port in remote-url is valid.

      Example: nv action update cluster apps nmx-controller log-stream elk user:password@192.168.1.100:6001

    • For splunk – server:port?query_string in remote-url is valid, and "" double quotation marks are needed.

      Example: nv action update cluster apps nmx-controller log-stream splunk "192.168.1.100:8088?api_token=xxxx-xxxx-xxxx-xxxx"

nv action restore cluster apps log-stream

nv action restore cluster apps <app-name> log-stream

Restore the log stream of a cluster application.

Syntax Description

app-name

The name of the cluster application

Default

N/A

History

25.02.4253

Example
Copy
Copied!
            

            
admin@nvos:~$ nv action update cluster apps nmx-controller log-stream

REST API

POST https://<ip>/nvue_v1/cluster/apps/[app-name]/log-stream

Related Commands

nv action update cluster apps <app-name> log-stream <protocol> <remote-url>

nv show cluster apps log-stream

Notes
© Copyright 2025, NVIDIA. Last updated on Sep 1, 2025.
content here