Appendix B Command-Line Tools

N1 Provisioning Server command-line tools comprise two categories:

Maintenance commands that you use to perform daily maintenance of an N1 Provisioning Server
Administrator tools that you use during set up and initialization of N1 Provisioning Server components

The following table lists all maintenance command-line tools with a brief description. For details regarding the options and parameters for each command, and what type of value each command takes, see the man page for that command.

Table B–1 Daily Maintenance Command-Line Tools


Command	Description
`aps`	Lists details of N1 Provisioning Server applications
`bill`	Manages billing events for a specified account
`console`	Gets console access to a device
`device`	Lists and manages devices in the control plane database (CPDB)
`devtype`	Lists and manages device types
`disk`	Lists and manages disks in the CPDB
`diskscrub`	Scrubs disk to all zeroes
`encrypter`	Generates an encrypted string from a clear text string
`farm`	Farm management tool
`image`	Manages images within the N1 Provisioning Server
`imagecopy`	Copies images to disks and vice versa
`lockfarm`	Locks and unlocks a farm to prevent modifications to it
`lr`	Lists the resources used by a farm
`mls`	Lists monitoring information
`power`	Manages power for devices
`replacedevice`	Replaces a device in a farm
`request`	Lists and manages requests in the N1 Provisioning Server
`resetpasswd`	Restores the password on a farm, device, or device type
`rsck`	Checks the availability of resources required to allocate the farm
`snapshot`	Takes image snapshots
`subnet`	Lists and manages subnets and IP addresses
`vlan`	Manages VLANs in the CPDB
`vlanconfig`	Gets VLAN for a device, lists devices in a VLAN, and sets a VLAN for a device

The following table lists all administrator command-line tools with a brief description. For details regarding the options and parameters for each command, and what type of value each command takes, see the man page for that command.

Table B–2 Administrator Command-Line Tools


Command	Description
`backupdb`	Backs up the CPDB.
`cecmd`	Executes a remote command using the N1 Provisioning Server agent.
`cereg`	Registers a device for monitoring.
`check_rel`	Checks the version of the installed N1 Provisioning Server software and verify that the correct packages and versions are installed for the server's assigned role. The following roles are available, and they are listed in the `/opt/terraspring/etc/Roles` file: `CC` – Control Center `CPDB` – control plane database CP – control plane server STMC – Storage manager client (displays global images onto server blades and administers snapshots)
`deletesfb1600`	Deletes server blade configurations from the CPDB.
`dhcpmod`	Modifies the DHCP configuration.
`discoversfb1600`	Discovers the server blade configuration and adds it to the CPDB.
`dnsmod`	Modifies the DNS configuration.
`fmrouter`	Provides information to set up external routers to farms.
`imageserversetup`	Sets up the image server.
`imagesync`	Marks an image as done in the database.
`imagewizard`	Launches the image management tool.
`mmd`	Starts or stops the monitoring manager.
`newtsprdebug`	Rotates the log files specified in the configuration file `/etc/opt/terraspring/logfile_rotation`.
`pestest`	Tests free resource pool servers to see whether they can be used in a farm.
`pesupdate`	Add, updates, or removes agent and application packages on resource pool servers in an active farm.
`restoredb`	Restores the CPDB from a previous backup.
`segment`	Lists and sets a data center name.
`setupimgsubnet`	Sets up or removes the image server subnet.
`shelfsync`	Synchronizes the physical state of resources with the database.
`sm`	Starts and stops a segment manager.
`snmpd`	Starts or stops the SNMP daemon.
`switchsync`	After a failed switch has been replaced, this command synchronizes the new switch with the configuration information stored in the database for the failed switch.
`uninstall_PS`	Uninstalls the N1 Provisioning Server software.
`wmld`	Prints CPDB information in Wiring Markup Language (WML) format.
`wmlp`	Processes a WML file to create CPDB data.

Previous: Appendix A Chargeable Events