Important

   

Starting version 8.9.03, BMC Server Automation is renamed to TrueSight Server Automation. This space contains information about BMC Server Automation 8.9.02 and previous versions. For TrueSight Server Automation 8.9.03 and later releases, see TrueSight Server Automation 8.9.

Summarized descriptions of Network Shell commands

The following table provides a brief description of all Network Shell commands and utilities. Commands that have been internationalized to support multibyte characters are indicated in the column on the right.

Note

To view a complete description of a command or utility, see the man page. To display a man page while using NSH, enter man <command>, such as man nsh.

Whenever you include the host name of a server as an argument in a command, ensure that your input matches the name specified when the server was added or enrolled. For example, if the server was added as server1.example.com (that is, using its fully qualified domain name), do not use server1 as the input in your NSH command or script.

Network Shell Command

Description

I18N Support

agentctl

Controls the functions of an RSCD agent.

NA

agentinfo

Provides information about an RSCD agent.

NA

awk

Scans files for specified patterns.

no

bl_gen_ssl

Creates an X.509 certificate.

NA

blcred

Manages authentication profiles, session credentials, and trusted certificates.

yes

blexpr

Creates and evaluates an expression based on input in the form of arguments.

yes

blkeylogman

Remotely manages keystroke log files on a computer running an RSCD agent.

yes

bllogman

Remotely manages live RSCD agent log files.

yes

blquery

Extends the functionality of blexpr by providing functions that are able to query the asset types supported by the BMC Server Automation environment.

yes

bzip2

Utility for compressing files using the Burrows-Wheeler block sorting text compression algorithm, and Huffman coding. Compression is generally considerably better than that achieved by more conventional compressors.

yes

cat

Concatenates and prints files.

yes

chapw

Sets or changes the agent password on one or more Windows servers that have the RSCD agent running.

NA

chgrp

Changes group (and user) ownership of files.

yes

chmod

Changes the mode (protection attributes) of a file.

yes

chown

Changes user (and group) ownerships of files.

yes

chrole

Changes only the role for new connections with Network Shell Proxy servers.

NA

cksum

Display file checksums and block counts.

yes

cmp

Compares the content of two files checking to see if they are identical.

yes

colrm

Removes columns from a file.

yes

comm

Selects or rejects lines common to two files.

yes

compress

Compresses data.

yes

cp

Copies files.

yes

csv2xml

Converts data in a comma-separated value format to XML format.

yes

cut

Selects portions of each line of a file.

yes

daalinfo

Displays an overview of the local DAAL registry.

NA

dd

Converts and copies a file.

yes

diff

Compares the differences between files and directories.

yes

df

Executes a remote df command.

yes

df2

Reports file system disk usage.

yes

dsync

Synchronizes two directories.

yes

du

Displays disk usage information for files.

yes

echo

Echoes arguments.

yes

expand

Expands tabs to spaces.

yes

fields

Extracts specified fields from a data row.

NA

file

Determines file type.

yes

find

Walks a file hierarchy.

yes

fold

Filters the contents of files to limit line length.

yes

fqdn

Prints fully qualified domain name of the current or specified host.

NA

funzip

Extracts files from a ZIP archive in a pipe.

yes

grep

Searches files and selects lines matching specified patterns.

yes

head

Displays the first few lines of a file.

yes

hexdump

Performs an ASCII, decimal, hexadecimal, or octal dump.

yes

hgrep

Highlights the results of a grep.

yes

hostname

Prints the name of the current host.

yes

join

Provides a relational database operator.

yes

lam

Outputs files side by side.

yes

less

Displays files on a CRT.

yes

lesskey

Specifies key bindings that are used by the less command.

NA

link

Creates a link to a file.

yes

ln

Creates a link to a file.

yes

ls

Lists the contents of a directory.

yes

man

Get man pages from a remote host.

NA

md5sum

Calculate the MD5 checksum of files.

yes

mkdir

Create directories.

yes

mkfifo

Creates a named pipe.

yes

mknod

Creates a special file.

yes

mv

Moves or renames files.

yes

ncp

Copies/synchronizes multiple sources to multiple destinations.

yes

ncpu

Displays CPU information.

NA

ndf

View usage statistics from one or more hosts.

NA

ndircmp

Compares contents of multiple directories.

yes

ndsync

Copies/synchronizes multiple sources to multiple destinations.

yes

nexec

Provides an interface for running remote commands.

yes

nlogin

Log on to a remote host.

NA

nmem

View memory and swap statistics from one or more hosts.

NA

nnet

Displays network adaptor configuration data for one or more servers.

NA

nohup

Invokes a command immune to hangups.

yes

nover

Displays a system overview in a standardized format independent of the server's operating system.

NA

nprocsum

Displays process summary from one or more hosts.

NA

nps

Displays process information from one or more hosts.

NA

nsh

Outlines the differences between Network Shell and other shells.

yes

NSH::

(NSH perl module)

Describes the use of the Network Shell Perl module.

For a list of functions offered by the Network Shell Perl module, see Network Shell Perl module functions. More information about all these functions is available on the NSH-Perl man page.

NA

nshopt

Tests different network write buffer sizes.

NA

nshpath

Shows the path where an nsh executable resides.

yes

nstats

Displays a system overview in a standardized format independent of the server's operating system.

NA

ntop

Provides a collection of commands used to view information and statistics for one or more servers.

NA

nukecert

Removes certificates from servers.

NA

nunzip

Decompresses or compresses files.

yes

order

Sorts a list of strings (or lines) in a specified order.

yes

paste

Merges corresponding or subsequent lines of files.

yes

pax

Reads and writes file archives and copies directory hierarchies.

yes

pkgadd

Provides a Network Shell wrapper to the pkgadd command.

NA

pr

Print files.

yes

prune

Prunes log files to a specified size.

yes

putcert

Pushes a certificate generated by bl_gen_ssl to one or more servers.

NA

redi

Redirects input to a file.

yes

renice

Alters the priority of running processes.

NA

rm

Removes a file.

yes

rmdir

Removes an empty directory.

yes

rscd

Describes the Remote System Call Daemon (the RSCD agent).

yes

rsu

Runs an NSH command with alternate privileges.

yes

runcmd

Runs a Network Shell command on one or more hosts.

yes

runscript

Runs a Network Shell script on one or more hosts.

yes

scriptutil

Copies and executes scripts on remote servers.

yes

sdiff

Compares the differences between files and directories side-by-side.

yes

secadmin

Defines encryption security when modifying the secure file.

NA

sed

Provides a stream editor.

yes

sort

Sorts or merges text files.

yes

split

Splits a file into pieces.

yes

strings

Finds printable strings in a file.

yes

su

Substitutes a user identity.

NA

tail

Outputs the last part of files.

yes

tar

Reads and writes file archives and copies directory hierarchies.

yes

tee

Copies standard input to standard output, making copies of the input.

yes

test

Tests the value of an expression.

yes

touch

Changes the last update and modification times of a file.

yes

tr

Translates or deletes characters.

yes

uname

Prints the operating system name.

NA

uncompress

Expands compressed data.

yes

uncp

Uncopies files that were backed up during a cp or dsync.

yes

unexpand

Replaces spaces with tabs (see also expand ).

yes

uniq

Reports or filters out repeated lines in a file.

yes

unlink

Unlinks a file and/or directory.

yes

unzip

Lists, tests, and extracts compressed files in a ZIP archive.

yes

unzipsfx

Provides a self-extracting stub for prepending to ZIP archives. This command is not supported in Windows and DOS.

yes

uuencode

Encodes a binary file.

yes

uudecode

Decodes a binary file.

yes

version

Tells what version of BMC Server Automation software is installed on a server.

NA

vi

Provides a text editor.

no

vsh

Starts a shell and captures input and output.

NA

vshview

Views the log files created by vsh.

NA

vtree

Shows the directory structure of a file system.

yes

wc

Counts the number of lines, words, and/or characters in a file.

yes

zcat

Expands compressed data. ( zcat is an alias for uncompress.)

yes

zip

Packages and compresses (archives) files.

yes

zipcloak

Packages and compresses (archives) files.

yes

zipgrep

Searches files in an archive for lines matching a pattern.

yes

zipinfo

Lists detailed information about an archive.

yes

zipnote

Packages and compresses (archives) files.

yes

zipsplit

Packages and compresses (archives) files.

yes

zshall

Provides man pages for Network Shell's preferred command interpreter, the Z shell.

Zsh 4.0.4: no Zsh 4.3.4: yes

Remote Commands

Remote commands are executed in the context of a remote host. See below for a list of remote commands used in Network Shell. For a full description of the command and usage information, see the man pages.

Note

The remote commands execution and availability of man pages is dependent on the target OS rather than the NSH. So if the target OS has the man page then it appears in the NSH. But if the target OS does not have the man page then it will not appear in the NSH. For more information on the remote commands and the man pages, see the corresponding OS documentation.

Remote Command

Description

arp

Displays and modifies the Internet-to-adapter address translation tables.

finger

Displays user information. This command is the same as the f command.

ifconfig

Configures or displays network interface parameters for a network using TCP/IP.

iostat

Generates reports that can be used to change system configuration to better balance the I/O load between file systems, physical volumes, and adapters.

ipconfig

Displays the IP address, subnet mask, and default gateway for all network adapters.

kmtune

Queries, sets, or resets system parameters.

mem

Provides privileged virtual memory read and write access.

modinfo

Displays information about a kernel module.

modload

Loads kernel modules on demand.

modunload

Unloads one or all unloadable modules from the running kernel.

mount

Makes a file system available for use.

nbtstat

Refreshes the NetBIOS name cache and the names registered with Windows Internet Name Service (WINS). It also displays the following:

  • NetBIOS over TCP/IP (NetBT) protocol statistics
  • NetBIOS name tables for both the local computer and remote computers
  • NetBIOS name cache

net

Updates, fixes, or displays the network or network settings.

netstat

Symbolically displays the contents of various network-related data structures for active connections.

nfsstat

Displays statistical information about the Network File System (NFS) and Remote Procedure Call (RPC) calls.

pagesize

Prints the size (in bytes) of a page of memory as returned by the getpagesize subroutine.

pgrep

Searches the process table on the running system and prints the process IDs of all processes that match the criteria given on the command line.

pkill

Searches the process table on the running system and signals all processes that match the criteria given on the command line.

prtconf

Displays system configuration information.

ps

Displays the status of processes.

showprogs

Displays list of software installed on a Windows system.

showfixes

Lists information about the interim fixes that have been applied to a currently installed process solution package.

size

Displays the section sizes of the Extended Common Object File Format (XCOFF) object files.

start

Opens a new command line window to run a specified program or command. The start command can also be used to start an application without creating a new window.

swap

Performs administrative functions on paging space.

sysdef

Displays the current system definition in a tabular form. It lists all hardware devices, pseudo devices, system devices, loadable modules, and the values of selected kernel tunable parameters.

umount

Unmounts a previously mounted file system, directory, or file.

uptime

Shows how long the system has been up.

who

Identifies the users currently logged in.

xbiff

Displays an image of a mailbox with a flag. The flag on the mailbox goes up with a beeping sound whenever there is new mail.

xterm

Provides a terminal emulator for the X Window System.

Was this page helpful? Yes No Submitting... Thank you

Comments