NVIDIA UFM-SDN Appliance Command Reference Guide v4.18.0

NVIDIA Docs Hub NVIDIA Networking Networking Software Management Software NVIDIA UFM-SDN Appliance Command Reference Guide v4.18.0 NVP

On This Page

nvp set
nvp get
nvp dump
nvp append
nvp reset
nvp discard
nvp backup
nvp delete
nvp fetch
nvp upload
nvp rollback
nvp apply

NVP

nvp set

	nvp set <file-name> <key> <value> [force] Changes the configuration of a file based on the key-value pair provided by the user
Syntax Description	file-name	Refers to the file name
	key	Refers to the key
	value	Refers to the value
	force	Allows the command to proceed even if the configuration does not currently exist
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp set opensm.conf qos TRUE`
Related Commands	nvp get
Notes	Force Option: If the `force` flag is included, it allows the command to proceed even if the configuration does not currently exist. For example, it can create a new section in INI files if needed. Without the `force` option, the command will only update existing entries.

nvp get

	nvp get <file-name> <key> Retrieve the configuration of file based on the key entered by the user
Syntax Description	file-name	Refers to the file name
Syntax Description	key	Refers to the key
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp get opensm.conf qos`
Related Commands	nvp set
Notes	Get can retrieve the configuration of only those files, that have been modified via the nvp set.

nvp dump

	nvp dump Generates a JSON file containing the configuration of all the NVP-supported configuration files
Syntax Description	N/A
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp dump Dump file created at /opt/ufm/files/conf/plugins/tools/nvp/nvp_dump.json`
Related Commands	nvp set nvp append
Notes

nvp append

	nvp append <file-name> <config-line> Adds any new configuration line as plain text to the configuration
Syntax Description	file-name	Refers to the file name
Syntax Description	config-line	Refers to the config line
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp append root_guid.conf "root_switches"`
Related Commands	nvp reset
Notes

nvp reset

	nvp reset <file-name> Clears the configuration file that has a plain text format
Syntax Description	file-name	Refers to the file name
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp reset root_guid.conf`
Related Commands	nvp append
Notes

nvp discard

	nvp discard [file-name] Removes configuration changes from the transaction folder in NVP.
Syntax Description	file-name	Refers to the file name
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp discard gv.cfg`
Related Commands	nvp set nvp append
Notes

nvp backup

	nvp backup [backup-name] Creates a backup archive of all NVP-supported configuration files.
Syntax Description	backup-name	Name of the archive containing the backup configuration
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp backup Backup 'nvp_backup_2024-10-31_09-12-59.tar.gz' created successfully.`
Related Commands	nvp upload nvp delete
Notes

nvp delete

	nvp delete <backup-name> Removes a specified backup file created using the `backup` command.
Syntax Description	backup-name	Name of the archive containing the backup configuration
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp delete nvp_backup_2024-10-31_09-12-59.tar.gz`
Related Commands	nvp backup
Notes

nvp fetch

	nvp fetch <url> Download an NVP backup archive file from a remote host.
Syntax Description	url	The URL path from where the NVP archive file can be downloaded. https, scp and sftp are supported. Example: scp://username[:password]@hostname/path/filename
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp fetch scp://root:123456@10.10.0.6/tmp/nvp_backup_2024-10-31_09-19-07.tar.gz`
Related Commands	nvp backup nvp upload
Notes

nvp upload

	nvp upload <backup-name> <url> Uploads an NVP backup archive file to a remote host.
Syntax Description	backup-name	Name of the backup file
Syntax Description	url	The URL path where the NVP archive file can be uploaded to. Supported formats: https, scp and sftp. Example: scp://username[:password]@hostname/path/filename
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp upload nvp_backup_2024-10-31_09-19-07.tar.gz scp://root:123456@10.0.0.6/tmp`
Related Commands	nvp backup
Notes

nvp rollback

	nvp rollback <backup-name> [force] Restores a previous configuration from a specified backup file in NVP
Syntax Description	backup-name	Name of the archive file containing the backup configuration
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp rollback nvp_backup_2024-10-31_09-19-07.tar.gz`
Related Commands	nvp backup nvp apply
Notes	If the `force` option is included, there will be no prompts. Since the Rollback action overwrites the transactional folder, users must subsequently call `APPLY` to implement the changes from the transactional folder to the UFM configuration.

nvp apply

	nvp apply [ force \| no-restart] Moves all the files that have been changed via the nvp set / append commands to their original location and restarts the UFM Server for changes to take effect.
Syntax Description	force	Performs nvp apply without any prompts
	no-restart	Apply the updated configuration without restarting UFM.
Default	N/A
Configuration Mode	config
History	4.18.0
Example	Copy Copied! `ufmapl [ mgmt-ha-active ] (config) # nvp apply force`
Related Commands	nvp set nvp append nvp reset nvp discard
Notes

© Copyright 2024, NVIDIA. Last updated on Nov 7, 2024.