8 Krypton

Ask the Expert Summary: Networker CLI nsradmin

Ask the Expert Summary: Networker CLI nsradmin


Please click here for all contents shared by us


This article summarizes the Chinese ATE Networker CLI nsradmin. 

Detailed Information

Q1: What’s the main feature of nsradm command? How to use it for getting start?

A1: nsradmin is a command-line utility used to view, create, delete, and modify resources. When run on a UNIX host, it can be run in full-screen mode using a curses-based interface. The curses API is not available in Microsoft Windows. nsradmin is command-line of Networker Management Console (NMC) , it can perform some tasks which NMC can’t do.

For example, if you backup environment clients configuration changes, like IP address, it receives “NSR Peer Information Conflict”. In order to resolve the issue, we have to delete the NSR Peer Information. At this time, you will receives continuous error when perform the deletion action in NMC, but you can do it through nsradmin.

nsradmin can be run from any NetWorker host. To open a connection to a specific NetWorker server, run the command with the -s server option.

After starting nsradmin, enter nsradmin-specific commands at the nsradmin> prompt. The format of a nsradmin command is:

cmd [argument [;argument]]

Where cmd is a name of a command and argument is specified in the form of an attribute list. An attribute is a name optionally followed by a colon, followed by one or more values separated by commas. One or more attributes are separated by semicolons.

NSR client command is used to display all the attributes of all client resources in the resource database. To limit the output to a single client, for example, leg-win1, the command is:

print type: NSR client; name: <client_name>

nsradmin can

also run in a non-interactive mode using a specified text file for the command list.

See the nsradmin topic in the EMC NetWorker Command Reference Guide or the UNIX/Linux man pages for a list of nsradmin options, resources and commands.

See https://support.emc.com/docu9466_Special-Uses-for-the-NetWorker-nsradmin-Program-Technical-Note.pdf?... for more examples.

Q2: Regarding the issue of NSR Peer Information Conflict, What is ‘Peer Information’? How to delete it via nsradmin command?

A2: ‘NSR Peer Information’ is the cached host certificates of clients which stored on Networker Server. When the Networker client launch the first time backup job, Networker Server will created its peer information which stored clients configuration information. It also will be reflected from NMC console – configuration – local host. In case, backup client configuration changes, like IP address, Networker Server is unable to update the cached information. Sometimes ‘Peer Information’ need to be manually delete then updated once next backup job ran. 

Run following command on Networker server side:

1, nsradmin -p nsrexecd

> . type:nsr peer information;name:<client name>

> p [Display]

> d [Delete]

> y [Confirm Deletion]

Above command is to delete the client information on Networker Server side.

2. nsradmin -s <client name> -p nsrexecd

> . type:nsr peer information

> p

> y

Above command is to delete the server information on Networker Client side.

Q3: How to create schedule via nsradmin command? For example, Mon - Fri + Sun: Incremental, 3rd Sat: Full, Other Sat: Incr Synthentic Full

A3: Yes, you can do it via nsradmin, but It’s not recommended to create the schedule through nsradmin, NMC is still the first choice.

# nsradmin

> create type:nsr schedule;name:test1;period:week;action:incr incr incr incr incr incr incr+synthetic full;override:full third Saturday every month

Q4: Can you provide some example to use nsradmin for Networker troubleshooting?

A4: nsradmin can be used to troubleshooting in case Networker is unable to be logged in as well as offline configuration file analytics. For example, customer has Networker problem but unable to provide remote connection, EMC support engineer can use nsradmin to collect related configuration for troubleshooting.

Nsradmin also can be used to perform following troubleshooting actions:

Clean the peer information.

Modify authentication information of Networker Server.

To delete the resources of mixed up windows in NMC.

To delete the storage node but not remove the devices.

To display the client attributes with exported client list,

1.     edit client.txt with following commands:

. type:nsr client

show name


save to nam


run below command to save all the clients attributes into clients.txt

nsradmin -i name.txt > client.txt

To convert .raw log file to txt log file,.

nsradmin -p nsrexec

. type: nsr log;name:daemon.raw

update: runtime rendered log: /nsr/logs/daemon.txt


After reboot the server, deamon.txt appears under log folder which is easy to read.

Q5: I realized the nsradmin command has some differences between Networker 7.6 and Networker 8. I remember I have to make some adjustment of 7.8 nsradmin command to be able to run in Networker 8. But I can’t find any official document to describe it.

A5: Yes, there is some little changes between different versions of Networker, please refer the related Networker Command Guide.

Q6: Regarding the command of . type:nsr client, What’s the mean of first dot?

A6: The dot means you’re under the type of resource then you can perform the operation. For example, after enter .type: NSR client, you’re able to run further command. It’s similar like cd.

Q7: Is it possible to run the nsradmin command from Networker client side? Is it same as from Networker Server? If backup job is running, does it impact the backup job if using nsradmin command to update the resource? Does Networker has any mechanism to prevent it?

A7: nsradmin is able to be ran on Networker Client side, but nsradmin is used to perform operation for configuration. By default , nsradmin = nasradmin –p nsrd, as there is only nsrexecd on Networker client, so it’s only able to run nsradmin –p nsrexecd from Networker client side to display client configuration info and clean peer information etc.

Usually nsradmin is for configuration changes, when backup is running, the configuration changes might be impacted the current backup job. It only affects next time backup runs.  In some cases, some important attributes are read only and not allowed to be changed

Q8: What’s the Networker authentication info, How to modify it through nsradmin command?

A8: You can use below command to display the auth info. We recommend you to change it with EMC support advisory.

nsradmin -p nsrexec

nsradmin> . type :nsrla

Current query set

nsradmin> show auth methods

nsradmin> print

auth methods: ",nsrauth/oldauth";

nsradmin> quit

Q9: Is it recommended to shut down the Networker service when run the nsradmin command?

A9: No. You can’t run when networker service is shut down. But in case the networker service is unable to start, you can use nsradmin –d, the default path is:

Windows (default)...

          nsradmin -d "C:\Program Files\Legato\nsr\res\nsrdb"

UNIX (default)...

          nsradmin -d /nsr/res/nsrdb

Author: Fenglin Li


Tags (3)
2 Replies
8 Krypton

Re: Ask the Expert Summary: Networker CLI nsradmin

A4 - you mean after restart of nsrexecd and not reboot of the server....

0 Kudos
8 Krypton

Re: Ask the Expert Summary: Networker CLI nsradmin

Your summary is fine although there are some issues which i want to clarify:


   nsradmin is part of the NW client package that's why you can run it on each NW client.


    With respect of the certificates - these are handled by the NW client daemon (nsrexecd) thats why you must run:

       nsradmin -p nsrexec   -s <client_name>     

       nsradmin -p nsrexecd -s <client_name>      will also be o.k.

   Of course, the NW server has also the client package installed.


   Actually, the dot (like in ". type ...") is the command for a query of the resourse database.

   Run "help" to see a list of all commands.


   I am not sure whether you must reboot the server - restarting NW should already do the job.


  - nsradmin -p nsrexec -s <client_name>      connects to the 'client side resource db'  (/nsr/res/nsrladb)

  - nsradmin                   -s <server_name>    connects to the 'server side resource db' (/nsr/res/nsrdb)

    Of course you must be an administrative NetWorker user.

  - Even if you deal with a NW server for UNIX/Linux i recommend to use nsradmin from a Windows machine.

    You will love the command buffer ... which even remains when you dropped the connection in the interim.