What can I help you with?

NVIDIA NVOS User Manual for NVLink Switches v25.02.2141

NVIDIA Docs Hub NVIDIA Networking Networking Software Switch Software NVIDIA NVOS User Manual for NVLink Switches v25.02.2141 Cluster Manager Commands

On This Page

nv show cluster apps manager
nv show cluster apps manager encryption
nv show cluster apps manager certificate
nv show cluster apps manager ca-certificate
nv action update cluster apps manager
nv action update cluster apps manager certificate
nv action update cluster apps manager ca-certificate
nv action update cluster apps manager encryption
nv action restore cluster apps manager encryption
nv action restore cluster apps manager
nv action restore cluster apps manager certificate
nv action restore cluster apps manager ca-certificate

Cluster Manager Commands

nv show cluster apps manager

	nv show cluster apps <app-name> manager Show a list of manager attributes.
Syntax Description	N/A
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv show cluster apps <app-name> manager operational -------------- ----------- ca-certificate ca certificate cert_id_03 encryption disabled state disabled`
REST API	GET https://<ip>/nvue_v1/cluster/apps/<app-name>/manager
Related Commands	nv show cluster apps <app-name> manager encryption nv show cluster apps <app-name> manager certificates
Notes	When cluster is disabled, no apps will be accepted as valid app names.

nv show cluster apps manager encryption

	nv show cluster apps <app-name> manager encryption Shows encryption mode which is disabled, mTLS, or TLS.
Syntax Description	N/A
Default	Disabled
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv show cluster apps <app-name> manager encryption ---------- ----------- encryption disabled`
REST API	GET https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/encryption
Related Commands	nv show cluster apps <app-name> manager certificates
Notes	When the cluster is disabled, no apps will be accepted as valid app name

nv show cluster apps manager certificate

	nv show cluster apps <app-name> manager certificate Shows the certificate ID which the cluster apps <app-name> manager is bounded to.
Syntax Description	app-name	Application name
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv show cluster apps <app-name> manager certificate operational ----------- ----------- certificate cert_id_03`
REST API	GET https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/certificate
Related Commands	nv show cluster apps <app-name> manager ca-certificate
Notes	When the cluster is disabled, no apps will be accepted as valid app name

nv show cluster apps manager ca-certificate

	nv show cluster apps <app-name> manager ca-certificate Shows the ca certificate ID which the cluster apps <app-name> manager is bounded to.
Syntax Description	pp-name	Application name
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv show cluster apps <app-name> manager ca-certificate operational ----------- ----------- Ca-certificate ca-name`
REST API	GET https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/ca-certificate
Related Commands	nv show cluster apps <app-name> manager ca-certificate
Notes	When the cluster is disabled, no apps will be accepted as valid app name

nv action update cluster apps manager

	nv action update cluster apps <app-name> manager This action enables the cluster apps <app-name> manager communication. It opens an external port in the device for communication between the cluster app and the cluster manager.
Syntax Description	app-name	Application name
Default	Disabled
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action update cluster apps <app-name> manager Action executing ... Cluster App Manager Port updated successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager
Related Commands	nv action update cluster apps <app-name> manager encryption
Notes	Dependency that cluster state is enabled.

nv action update cluster apps manager certificate

	nv action update cluster apps <app-name> manager certificate <cert-id> This command binds the certificate in the system to be used by the cluster manager.
Syntax Description	cert-id	Certificate ID
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action update cluster apps <app-name> manager certificate cert_id_03 Action executing ... Cluster App Manager Cert updated successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/certificate
Related Commands	nv action update cluster apps <app-name> manager encryption
Notes	The operation should be rejected if one of the following occurs: cluster is disabled The <cert-id> does not include: cert and private key The certificate extended key usage does not have TLS client authentication Given app is not valid

nv action update cluster apps manager ca-certificate

	nv action update cluster apps <app-name> manager ca-certificate <cacert-id> This command binds the ca certificate that exists in the system to be used by the cluster apps <app-name> manager.
Syntax Description	cacert-id	CA certificate ID
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action update cluster apps <app-name> manager ca-certificate ca_id Action executing ... Cluster App Manager CA Cert updated successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/certificate @update {cacert-id: <cacert-id>}
Related Commands	nv action update cluster apps <app-name> manager encryption
Notes	the <cacert-id> certificate was imported by nv action import system security ca-certificate “ca data” The operation should be rejected, if one of the following occurs: cluster is disabled The <ca-cert-id> does not include ca cert Given app is not valid

nv action update cluster apps manager encryption

	nv action update cluster apps <app-name> manager encryption <disabled \| tls \| mtls> This command sets which encryption mode will be used when using cluster apps <app-name> manager.
Syntax Description	disabled	The cluster apps <app-name> manager feature will work with no encryption protocol
	tls	The cluster apps <app-name> manager feature will work with TLS protocol
	mtls	The cluster apps <app-name> manager feature will work with Mutual TLS (mTLS) protocol
Default	Disabled
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action update cluster apps <app-name> manager encryption tls Action executing ... Cluster App Manager Encryption updated successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/encryption
Related Commands	nv action update cluster apps <app-name> manager certificate
Notes	Requirement when mode is mTLS: The cluster state is enabled The certificate was bound to use TLS mode The CA certificate was bound to use mTLS mode Given app is valid Requirement when mode is TLS: The cluster state is enabled The certificate was bound to use TLS mode Given app is valid Requirement when mode is disabled: The cluster state is enabled Given app is valid

nv action restore cluster apps manager encryption

	nv action restore cluster apps <app-name> manager encryption This command is setting encryption mode disabled.
Syntax Description	app-name	Application name
Default	Disabled
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action restore cluster apps <app-name> manager encryption Action executing ... Cluster App Manager Encryption restored successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/encryption
Related Commands	nv action update cluster apps <app-name> manager certificate
Notes	Command should be rejected when the following occurs: cluster is disabled Given app is not valid

nv action restore cluster apps manager

	nv action restore cluster apps <app-name> manager This command disables the communication between the NMX app and NMX manager. This action sends a notification to the NMX app to close the port which listens to the NMX manager's requests.
Syntax Description	app-name	Application name
Default	Disabled
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action update cluster apps <app-name> manager Action executing ... Cluster App Manager Port restored successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager
Related Commands	nv action restore cluster apps <app-name> manager encryption
Notes	The operation should be rejected when the following occurs: cluster is disabled given app is invalid

nv action restore cluster apps manager certificate

	nv action restore cluster apps <app-name> manager certificate This command removes the bounded certificate used by the cluster apps <app-name> manager.
Syntax Description	app-name	Application name
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action restore cluster apps <app-name> manager certificate Action executing ... Cluster App Manager Cert restored successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/certificate
Related Commands	nv action restore cluster apps <app-name> manager encryption
Notes	Command should be rejected when: cluster is disabled cluster apps <app-name> manager encryption mode is "mtls/tls” given app is invalid

nv action restore cluster apps manager ca-certificate

	nv action restore cluster apps <app-name> manager ca-certificate This command removes the CA certificate used by the cluster apps <app-name> manager.
Syntax Description	app-name	Application name
Default	N/A
History	25.02.1884
Example	Copy Copied! `admin@nvos:~$ nv action restore cluster apps <app-name> manager ca-certificate Action executing ... Cluster App Manager CA Cert restored successfully Action succeeded`
REST API	POST https://<ip>/nvue_v1/cluster/apps/<app-name>/manager/certificate
Related Commands	nv action restore cluster apps <app-name> manager encryption
Notes	Command should be rejected when the following occurs: cluster is disabled cluster apps <app-name> manager encryption mode is "mtls" given app is invalid

© Copyright 2025, NVIDIA. Last updated on Apr 23, 2025.