This chapter provides the same help that you can access by using the help command in the command line.
You can get help in the following ways:
Type help command to describe the command and list the available command object commands.
Type help command object to display detailed usage information for the command object tuple.
Type help object to display detailed information for the object.
The available commands are listed in the following table.
Command |
Description |
---|---|
add |
Add a member to an object or group. |
connect |
Connect to a provisionable server's serial console. |
create |
Create (or copy) a new object in the N1 System Manager. |
delete |
Delete an object from the N1 System Manager. |
discover |
Discover new servers to be managed. |
exit |
Exit user from the N1-ok> shell. |
help |
Get help about a command or object. You can also use ? for the help command. |
load |
Install software on a server or group of servers. |
remove |
Remove a member from an object or group. |
reset |
Power off and power on a server or group of servers. |
set |
Change attributes on a server, a group of servers, or other object. |
show |
List summary or detailed information about an object or group. |
start |
Enable an object or issue a command, for example, power on and boot a server. |
stop |
Disable an object, for example, shut down and power off a server. |
unload |
Uninstall software from a server or group of servers. |
The available objects are described in Object Help.
This command adds a member to an object or group.
The add command can be used on the following objects: group, osprofile, role, server, and user.
Type help add object for details.
This command adds provisionable servers to a server group so you can more easily perform management operations on multiple servers.
Add one or more servers to a server group:
add group group server server[,server...] |
Add all the available servers to a server group:
add group group server all |
all – Add all servers to a server group.
group – The name of a server group.
server – The management name of a server to be added.
This command adds a distribution group, disk partition, OS update, or custom installation script to an existing OS profile.
If no distribution groups are specified, the Core distribution group is used for the Solaris(TM) operating system, the Base distribution group is used for the Red Hat operating system, and the Default Installation group is used for the SUSE operating system. At least one partition (root) is required for a valid Solaris profile, and at least two partitions (root and swap) are required for a valid Linux profile.
Add a distribution group to an OS profile:
add osprofile osprofile distributiongroup distributiongroup |
Add disk partition information to an OS profile:
add osprofile osprofile partition partition device device maxsize maxsize size size sizeoption sizeoption type type |
Add an OS update to an OS profile:
add osprofile osprofile update update |
Add a custom installation script to an OS profile:
add osprofile osprofile script script type type |
device – The disk slice for the partition. Examples: c1t1d0s1 (Solaris) or sda (Linux).
distributiongroup – The name of a distribution group (group of packages) to install. If you do not specify a distribution group, the following will be installed: Core System Support (Solaris), Base (Red Hat), or Default Installation (SUSE). You can display the distribution group list for an OS by using the show os os command.
maxsize – (Red Hat only) The maximum size for the file system in Mbytes. This option enables you to put a limit on the free value for sizeoption.
osprofile – The name of an OS profile.
partition – The mount point name for the partition. Default value is / (root).
script – The name of a custom installation script. A fully qualified path is required.
size – The size of the file system in Mbytes. This option must be specified with the fixed value for sizeoption.
sizeoption – The way to size the file system. Valid values are:
fixed – The file system is set to a specific size, which is set by the size attribute.
free – The remaining unused space on the disk is used for the file system. With a Red Hat profile, you can specify maxsize to limit the size of the file system.
type (adding partition) – The type of file system. Default values areufs (Solaris) and ext3 (Linux). Valid values are:
Solaris: swap or ufs
Red Hat: ext2, ext3, swap, or vfat
SUSE: ext2, ext3, jfs, reiser, swap, or xfs
type (adding script) – The time when the custom script will run during the installation. Valid values are:
pre – Run the script before the installation (for example, drivers).
post – Run the script after the installation.
postnochroot – Run the script after the installation. The script does not have to be run as superuser (root).
update – The name of an OS update.
This command adds privileges to a role.
Add all privileges to a role:
add role role privilege all |
Add one or more privileges to a role:
add role role privilege privilege[,privilege...] |
all – Add all privileges to the role.
role – The name of a role. You cannot add privileges to the system default roles: Admin, SecurityAdmin, and ReadOnly. These roles are predefined and cannot be modified.
privilege – The name of a privilege to add to the role. Use the show privilege all command to list all available privileges.
This command adds roles to a user. Once added, the user will be able to assume each role and gain the associated privileges.
Add a role to a user:
add user user role role[,role...] |
role – The name of a role to add to the user. Use the show role all command to list all available valid roles.
user – The name of a user.
This command adds support features to a provisionable server.
Add OS monitoring and base management support to a provisionable server:
add server server feature osmonitor agentip agentip agentssh agentssh |
Add base management support to a provisionable server:
add server server feature basemanagement agentip agentip agentssh agentssh |
agentip – Specify the IP address used for OS monitoring on the provisionable server, which should be the IP address of the provisioning network interface on the server.
agentssh – Specify the SSH credentials used for OS monitoring on the provisionable server. The SSH user must have root access on the provisionable server. The agentssh format is a user name/password pair for SSH credentials: ssh-username/ssh-password.
basemanagement – Provides support for OS update deployment and remote commands.
osmonitor – Provides support for OS monitoring and the basemanagement feature. This enables you to monitor OS resources status information (also known as utilization) for the server. See the show server command for more details.
server – The management name of a server.
This command connects you to the serial console of a provisionable server.
The connect command can be used on the server object.
Type help connect server for details.
This command connects you to the serial console of a provisionable server.
You can use the connect server command to monitor installations or perform administration tasks. For most hardware platforms, the first user to log in is given read and write privileges on the serial console, and subsequent user sessions are read-only mode. Some platforms don't allow multiple serial console sessions on the same server. You can exit the serial console at any time through the following escape sequences:
ALOM-based systems – # .
Sun Fire(TM) X4000 series systems – ESC (
Sun Fire V20z and V40z systems – ^E c .
Note that this command is not available in the browser interface's command line, but you can access a server's serial console in the browser interface by choosing Open Serial Console in the Actions menu. Also, because this command requires user input, do not use it in a custom N1 System Manager script through the n1sh -f command.
Connect to a provisionable server's serial console.
connect server server |
server – The management name of a provisionable server.
This command creates a new object in the N1 System Manager. You can also use this command to copy objects that already exist outside N1 System Manager.
The create command can be used on the following objects: firmware, group, notification, os, osprofile, role, update, and user.
Type help create object for details.
See discover for information on adding provisionable servers to the N1 System Manager.
This command copies a firmware update to the N1 System Manager. You can then install the firmware update on the provisionable servers.
Copy a firmware update to the N1 System Manager:
create firmware firmware [description description] model model[,model] [type type] url url vendor vendor [version version] |
description – A description for the firmware update.
firmware – A unique name for the firmware update.
model – The model name of a valid hardware system for the firmware update. Valid values are:
NETRA-240 – Netra(TM) 240
SF-V210 – Sun Fire V210
SF-V240 – Sun Fire V240
SF-V250 – Sun Fire V250
SF-V440 – Sun Fire V440
V20z – Sun Fire V20z
V40z – Sun Fire V40z
X4100 – Sun Fire X4100
X4200 – Sun Fire X4200
type – The type of firmware update. This attribute is required only for the Sun Fire V20z and Sun Fire V40z system firmware updates. Valid values are:
BIOS – Server platform BIOS
PIC – Service processor operator panel
SP – Service processor
url – The URL path to a firmware update to copy. Use file:/// for a file accessible from the management server or http:// for a file located on a web site.
vendor – The name of the firmware update vendor. Valid value is Sun.
version – The version number of the firmware update.
This command creates a new server group, which enables you to group provisionable servers by business or management needs.
Create a new server group and add servers to it:
create group group server server[,server] |
Create a new server group and add all servers to it:
create group group server all |
all – Add all servers to server group.
group – A name for the new server group.
server – The management name of a provisionable server.
This command creates a new notification rule.
Create a new notification rule:
create notification notification destination destination topic topic type type [description description] |
description – A description for the notification rule.
destination – Where to send the notification. This value must match the specified type. Valid values are:
email-addresses – One or more email addresses separated by commas.
snmp-host[:port] – An SNMP host. snmp-host is a valid SNMP host name and port is a valid port on the host.
notification – A name for the notification rule.
topic – The type of event to trigger the notification. Valid values are:
Action.Logical.FirmwareCreate (firmware created)
Action.Logical.FirmwareDelete (firmware deleted)
Action.Logical.JobCompleted (job completed)
Action.Logical.JobStarted (job started)
Action.Logical.ProfileCreate (OS profile created)
Action.Logical.ProfileDelete (OS profile deleted)
Action.Logical.OSDeployComplete (OS deployment completed)
Action.Logical.OSDeployStart (OS deployment started)
Action.Physical.AddCoreJobSuccess (Base management support added)
Action.Physical.AgentIPJobSuccess (Feature support modified)
Action.Physical.AlreadyKnown (server discovery already known)
Action.Physical.Discovered (server discovered)
Action.Physical.DriverNotFound (server discovery driver not found)
Action.Physical.FWNotCompatible (firmware level is not compatible or supported)
Action.Physical.InitialAddOsmJobSuccess (OS monitoring and base management support added)
Action.Physical.IPUnreachable (server discovery IP address unreachable)
Action.Physical.LoadUpdateSuccess (OS update deployment succeeded)
Action.Physical.LoadUpdateFailure (OS update deployment failed)
Action.Physical.LoadUpdateCanceled (OS update deployment canceled)
Action.Physical.MultipleAuths (server discovery multiple authorizations)
Action.Physical.MultipleIPs (server discovery multiple IP addresses)
Action.Physical.RemoteCmdFailure (remote command failed)
Action.Physical.RemoteCmdSuccess (remote command succeeded)
Action.Physical.RemoteCmdTimedOut (remote command timed out)
Action.Physical.RemoteCmdUnauthorized (remote command unauthorized)
Action.Physical.RemoveOsmJobSuccess (OS monitoring support removed)
Action.Physical.ServerDelete (server deleted)
Action.Physical.ServerStateChange (server changed)
Action.Physical.Unauthorized (server discovery unauthorized)
Action.Physical.UnloadUpdateSuccess (OS update unload succeeded)
Action.Physical.UnloadUpdateFailure (OS update unload failed)
Action.Physical.UnloadUpdateCanceled (OS update unload canceled)
EReport.Logical.ThresholdExceeded (OS resource threshold exceeded)
EReport.Physical.DomainException (domain exception)
EReport.Physical.Exception (remote command exception)
EReport.Physical.FWMgmtException (firmware update exception)
EReport.Physical.IOException (IO exception)
EReport.Physical.OpGrpException (server discovery operation group exception)
EReport.Physical.RemoteCmdUnknownOS (remote command unknown OS)
EReport.Physical.RemoteCmdUnknownServer (remote command unknown server)
EReport.Physical.ThresholdExceeded (hardware health threshold exceeded)
Lifecycle.Logical.AddServer (server added to group)
Lifecycle.Logical.ChangeSessionRole (session role changed)
Lifecycle.Logical.CreateGroup (group created)
Lifecycle.Logical.CreateUpdate (OS update created)
Lifecycle.Logical.DeleteGroup (group deleted)
Lifecycle.Logical.DeleteUpdate (OS update deleted)
Lifecycle.Logical.RemoveServer (server removed from group)
Lifecycle.Physical.DBUpdateFailed (firmware update database update failed)
Lifecycle.Physical.InvalidState (firmware update invalid device state
Lifecycle.Physical.ObjectJobNotFound (server not found for operation)
Lifecycle.Physical.UpdateSucceeded (firmware updated)
type – How to send the notification. Valid values are email (send to email address) or snmp (send to SNMP host).
This command copies an OS image to the management server so it can be installed on the provisionable servers.
You can copy an OS image, called an OS distribution, from ISO files, CDs, or a DVD. The OS distribution is stored in the /var/opt directory on the management server, so enough disk space must exist to hold the OS distributions you plan to copy.
Note that N1 System Manager does not support copying Solaris OS CDs and CD ISO files. You must copy a Solaris DVD or DVD ISO file.
When copying an OS distribution from multiple installation CDs, you need to run the create os command multiple times with the same OS distribution name. For example, if you are trying to copy an OS distribution that is provided on two CDs, you must insert the first CD, run the create os command, and wait for the job to complete. Once the first job completes, you then must insert the second CD, run the create os command again, and wait for the job to complete. The OS distribution is successfully installed when the second job completes.
A default OS profile is automatically created for each newly created OS distribution, with the same name as the OS distribution. The default profile is provided as an example. Most of the time, you will have to update the default profile to match your hardware or it may be easier to just create a new profile. Use the show osprofile osprofile command to see the configuration of an OS profile.
Copy an OS distribution from ISO files:
create os os file file[,file...] |
Copy an OS distribution from an installation CD/DVD:
create os os cdrom cdrom |
file – The name of an ISO file accessible from the management server. A fully qualified path is required.
cdrom – The fully qualified path to the installation CD/DVD.
os – A name for the OS distribution.
This command creates a new OS profile.
In addition to the create osprofile command, you must use the add osprofile command to add distribution groups, partition information, resources, and scripts to the OS profile to make it usable.
You can also use this command to clone (copy) an existing profile. This command must be used if you want to modify or copy a profile that has been used to install a provisionable server.
Create a new OS profile:
create osprofile osprofile os os rootpassword rootpassword [description description] [flar flar] [language language] [timezone timezone] |
Copy an existing OS profile:
create osprofile osprofile clone oldprofile |
os – The name of the OS distribution to install.
description – A description for the new OS profile.
flar – (Solaris only) The name of a Flash archive file. A fully qualified path must be specified.
language – The default language for the installation. Default value is en_US (English).
Valid values for a Linux profile are cs_CZ, da_DK, de_DE, en_US, es_ES, fr_FR, is_IS, it_IT, ja_JP.eucJP, ko_KR.eucKR, nl_NL, no_NO, pt_PT, ru_RU.k0I8r, sl_SI, sv_SE, uk_UA, zh_CN.GB2312, and zh_TW.Big5.
Valid values for a Solaris profile are C, en_US.ISO8859-15, en_US.ISO8859-1, and en_US.
rootpassword – The root password for the server after installation.
osprofile – A name for the new OS profile.
oldprofile – The name of the OS profile to be copied.
timezone – The time zone for the installation. Default value is gmt.
Valid values for a Linux profile are any of the time zones listed by the timeconfig command.
Valid values for a Solaris profile are provided by the directories and files in the /usr/share/lib/zoneinfo directory on a Solaris system. The timezone value is the name of the path relative to the /usr/share/lib/zoneinfo directory. For example, the timezone value for Mountain Standard Time in the United States is US/Mountain. The timezone value for Japan is Japan.
This command creates a new role. Unless privileges are specified, a new role has no privileges added to it by default.
Create a new role with one or more privileges:
create role role [description description] [privilege privilege[,privilege...]] |
description – A description for the new role.
privilege – The name of a privilege to add to the role. Use the show privilege all command to list all the available privileges. You can also use the add role command to add more privileges later.
role – A name for the new role.
This command copies an OS update to the N1 System Manager. You can then install the OS update on the provisionable servers.
You can add three different types of OS updates: RPMs for the Linux operating systems and packages or patches for the Solaris operating system.
Copy one or more OS updates from Linux RPMs, Solaris packages, or Solaris patches:
create update update file file ostype ostype[,ostype...][adminfile adminfile] [responsefile responsefile] |
adminfile – (Solaris package only) A fully qualified path to an admin file.
file – A fully qualified path to a file accessible from the management server or a URL location to a Linux RPM or Solaris patch/package. A Linux RPM must be a .rpm file, a Solaris package must be either a .pkg or .tar file, and a Solaris patch must be a *.zip file. Note that the .tar file must match the top-level directory name after the tar expansion. For example, if the tar file is SUNWstade.tar, the top-level directory of the tar expansion must be SUNWstade.
Examples: /tmp/test-i386.rpm or http://updatesite1/rpms/test-i386.rpm
ostype – A list of OS versions compatible with the OS update. The specified OS type must match the type of OS updates being added. Typically, only one OS type is valid for Solaris OS updates. Valid values are:
redhat-as3 – Red Hat Enterprise Linux AS 3.0
redhat-es3 – Red Hat Enterprise Linux ES 3.0
redhat-ws3 – Red Hat Enterprise Linux WS 3.0
redhat-as3-64 – Red Hat Enterprise Linux AS 3.0, 64-bit
redhat-es3-64 – Red Hat Enterprise Linux ES 3.0, 64-bit
redhat-ws3-64 – Red Hat Enterprise Linux WS 3.0, 64-bit
redhat-as4– Red Hat Enterprise Linux AS 4.0
redhat-es4 – Red Hat Enterprise Linux ES 4.0
redhat-ws4 – Red Hat Enterprise Linux WS 4.0
redhat-as4-64 – Red Hat Enterprise Linux AS 4.0, 64-bit
redhat-es4-64 – Red Hat Enterprise Linux ES 4.0, 64-bit
redhat-ws4-64 – Red Hat Enterprise Linux WS 4.0, 64-bit
solaris9x86 – Solaris x86 Version 9 Update 7
solaris10x86 – Solaris x86 Version 10
solaris9sparc – Solaris SPARC Version 9 Update 7
solaris10sparc – Solaris SPARC Version 10
suse-es9 – SUSE LINUX Enterprise Server 9
suse-es9-64 – SUSE LINUX Enterprise Server 9, 64-bit
responsefile – (Solaris package only) A fully qualified path to a response file.
update – A name for the OS update.
This command creates a new N1 System Manager user. The user must already exist on the OS of the management server. Unless roles are specified, a new user has no roles added to it by default.
Create a new N1 System Manager user with one or more roles:
create user user [role role[,role...]] |
role – The name of a role to add to the user. Use the show role all command to list all available valid roles. You can also use the add user command to add more roles later.
user – The name for the new user. The name must be the same as the corresponding user on the management server's operating system.
This command deletes an object from the N1 System Manager.
The delete command can be used on the following objects: firmware, group, job, notification, os, osprofile, role, server, update, and user.
Type help delete object for details.
This command deletes a firmware update from the N1 System Manager.
Delete a firmware update.
delete firmware firmware |
firmware – The name of a firmware update.
This command deletes a server group. This command will not delete the provisionable servers from the N1 System Manager.
Delete a server group:
delete group group |
group – The name of a server group to delete.
This command deletes jobs.
Delete a job:
delete job job |
Delete all jobs:
delete job all |
all – Delete all jobs.
job – A job identification number.
This command deletes a notification rule.
Delete a notification rule:
delete notification notification |
notification – The name of a notification rule to delete.
This command deletes an OS distribution from the N1 System Manager. An OS distribution cannot be deleted if it is associated with an OS profile currently installed on a provisionable server.
Delete an OS distribution:
delete os os |
os – The name of an OS distribution to delete.
This command deletes an OS profile. An OS profile cannot be deleted if it is currently being used by a provisionable server.
Delete an OS profile:
delete osprofile osprofile |
osprofile – The name of an OS profile to delete.
This command deletes a role. You cannot delete a role if it is assigned to a user.
Delete a role:
delete role role |
role – The name of a role to delete.
This command deletes servers from the N1 System Manager. The server will no longer appear in the list displayed using the show server all command.
Delete all servers from the N1 System Manager:
delete server all |
Delete a server from the N1 System Manager:
delete server server |
all – Delete all servers from the N1 System Manager.
server – The management name of a server.
This command deletes an OS update from the N1 System Manager.
Delete an OS update:
delete update update |
update – The name of an OS update to delete.
This command deletes a N1 System Manager user. This command does not delete the user from the OS of the management server.
Delete a N1 System Manager user:
delete user user |
user – The name of a user to delete.
This command discovers and adds new provisionable servers to be managed by the N1 System Manager.
Before a server can be discovered, the following conditions must be met:
The user knows the authentication credentials for the provisionable server or the server has factory-default credentials.
The management network IP address for the provisionable server is configured and is network accessible by the N1 System Manager. Check the Sun N1 System Manager Site Preparation Guide for details on adding a new provisionable server to the N1 System Manager environment.
Discover and add servers to the N1 System Manager:
discover ip [group group] [ipmi ipmi] [snmp snmp] [ssh ssh] [telnet telnet] |
ip – Specify the management network IP addresses of the provisionable servers you want to discover. You can specify multiple instances of ip in one of the following ways, separated by commas:
ip-address – A single management network IP address.
ip-address–ip-address – A range of management network IP addresses. Example: 10.5.10.1-10.5.10.100
subnet/mask-length – A subnet with a mask length. Example: 10.0.8/24 or 10.0.8.128/28
group – The name of a server group in which to add the discovered servers. If the server group does not exist, it will be created during the discovery.
ipmi – Use IPMI credentials to authenticate the discovery process based on the server's management network IP address. The ipmi value is an IPMI password. If IPMI credentials are not specified and the provisionable server is in the factory default state, the discovery process will set the server's IPMI password to admin.
snmp – Use SNMP credentials to authenticate the discovery process based on the server's management network IP address. The snmp format is a read community string for the SNMP credentials: read-community.
ssh – Use SSH credentials to authenticate the discovery process based on the server's management network IP address. The ssh format is a user name/password pair for SSH credentials: ssh-username/ssh-password. If SSH credentials are not specified and the provisionable server is in the factory default state, the discovery process will set the server's SSH user name/password to admin/admin.
telnet – Use telnet credentials to authenticate the discovery process based on server's management network IP address. The telnet credential is used only by ALOM-based systems. The telnet format is a user name/password pair for telnet credentials: telnet-username/telnet-password.
This command exits you out of the N1–ok> shell. If the N1–ok> shell is your default shell, you will be logged out of the N1 System Manager completely; otherwise, you will be returned to your previous shell on the management server.
Exit the N1-ok> shell.
exit |
This command installs software on provisionable servers.
The load command installs an OS distribution (using an OS profile), firmware update, or OS update (packages, patches, and RPMs). The load command can be used on the following objects: group and server.
Type help load object for details.
This command installs software on a group of provisionable servers, such as an OS distribution (through an OS profile), OS update, or firmware update.
Install a Solaris OS profile on a group of servers:
load group group osprofile osprofile ip ip networktype static [excludeserver server[,server...] [server-configuration-attributes] |
Install a Red Hat Linux or SUSE Linux OS profile on a group of servers:
load group group osprofile osprofile bootip bootip networktype networktype [ip ip] [excludeserver server[,server...] [install-attributes] [server-configuration-attributes] |
Install an OS update on a group of servers:
load group group update update[,update...] |
Install a firmware update on a group of servers:
load group group firmware firmware [force] |
bootip – (Linux only) The IP address for the server's provisioning network interface used to install the server, also known as the Provisioning IP. You can specify a range of IP addresses or a subnet mask. Specify a range of IP addresses as follows: ip-address-ip-address. Example: 10.0.0.1–10.0.0.3
excludeserver – Exclude one or more servers from the installation. server is the management name of a provisionable server.
firmware – The name of a firmware update. By default, the firmware update's model and vendor settings must match every provisionable server selected for installation. If the settings do not match, the update fails.
force – Force the firmware update installation without server validation.
group – The name of a server group.
ip – The IP address assigned to the server's provisioning network interface after the server is installed. This IP address is automatically used as the bootip (Provisioning IP) when installing the Solaris operating system. This attribute is required only if networktype is set to static. You can specify a range of IP addresses or a subnet mask. Specify a range of IP addresses as follows: ip-address-ip-address (Example: 10.0.0.1–10.0.0.3).
networktype – Specify how to assign an IP address to the server's provisioning network interface after the server is installed. Valid values are static or dhcp. If networktype is set to static, the ip attribute must be specified.
osprofile – The name of an OS profile used to install the OS.
update – The name of an OS update. If you specify more than one OS update, they must be the same OS type and ordered properly for any dependency issues. The OS updates will be installed in the order listed.
Install Attributes
The following attributes are temporarily used to boot and install the servers. The N1 System Manager provides default values for all of these attributes. These attributes are only required for a Red Hat Linux or SUSE Linux installation.
bootgateway bootgateway – A gateway used to install the servers.
bootnameserver bootnameserver – A name server used to install the servers.
bootnetmask bootnetmask – A netmask used to install the servers.
Server Configuration Attributes
The following attributes are used to configure the server's network information during the installation. The N1 System Manager provides default values for all of these attributes.
domainname domainname – (Solaris only) A domain assigned to the installed servers. If you do not specify this attribute, the management server domain will be used or sun.com.
gateway gateway – A gateway assigned to the installed servers.
kernelparameter kernelparameter – (Linux only) A parameter passed to the kernel during the install process.
nameserver nameserver – A name server assigned to the installed servers.
netmask netmask – A netmask assigned to the installed servers.
This command installs software on provisionable servers, such as an OS distribution (through an OS profile), OS update, or firmware update.
Install a Solaris OS profile on one or more servers:
load server server[,server...] osprofile osprofile ip ip networktype static [install-attributes] [server-configuration-attributes] |
Install a Red Hat OS Linux or SUSE Linux profile on one or more servers:
load server server[,server...] osprofile osprofile bootip bootip networktype networktype [ip ip] [install-attributes] [server-configuration-attributes] |
Install OS updates on one or more servers:
load server server[,server...] update update[,update...] |
Install a firmware update on one or more servers:
load server server[,server...] firmware firmware [force] |
bootip – (Linux only) The IP address for the server's provisioning network interface used to install the server, also known as the Provisioning IP. You can specify a single IP address, or a range of IP addresses or subnet mask if you are installing more than one server. Specify a range of IP addresses as follows: ip-address-ip-address Example: 10.0.0.1–10.0.0.3
firmware – The name of a firmware update. By default, the firmware update's model and vendor settings must match every provisionable server selected for installation; otherwise, the update fails.
force – Force the firmware update installation without server validation.
ip – The IP address assigned to the server's provisioning network interface after the server is installed. This IP address is automatically used as the bootip (Provisioning IP) when installing the Solaris operating system. This attribute is required only if networktype is set to static. You can specify a single IP address, or a range of IP addresses or a subnet mask if you are installing more than one server. Specify a range of IP addresses as follows: ip-address-ip-address (Example: 10.0.0.1–10.0.0.3).
networktype – Specify how to assign an IP address to the server's provisioning network interface after the server is installed. Valid values are static or dhcp. If networktype is set to static, the ip attribute must be specified.
osprofile – The name of an OS profile used to install the OS.
server – The management name of a provisionable server.
update – The name of an OS update. If you specify more than one OS update, they must be the same OS type and ordered properly for any dependency issues. The OS updates will be installed in the order listed.
Installation Attributes
The following attributes are temporarily used to install one or more servers. Some attributes can be specified only when installing a single server. The N1 System Manager provides default values for all the attributes that are not single-server specific.
bootgateway bootgateway – (Linux only) A gateway used to install the server.
boothostname boothostname – (Single server and Linux only) A host name used to install the server.
bootnameserver bootnameserver – (Linux only) A name server used to install the server.
bootnetmask bootnetmask – (Linux only) A netmask used to install the server.
bootnetworkdevice bootnetworkdevice – (Single server only) The server's provisioning network interface used to install the server. Valid Solaris values are bge0 and bge1. Valid Linux values are eth0 (default), eth1, eth2, eth3, and eth4.
bootpath bootpath – (Single server, Solaris x86 only) The server's provisioning boot device used to install the server. This attribute supercedes the bootnetworkdevice value, if specified. Valid values are:
/pci@0,0/pci1022,7450@a/pci17c2,10@2 – Sun Fire V20z, bge0 (default)
/pci@0,0/pci1022,7450@a/pci17c2,10@3 – Sun Fire V20z, bge1
/pci@0,0/pci1022,7450@a/pci17c2,20@2 – Sun Fire V40z, bge0 (default)
/pci@0,0/pci1022,7450@a/pci17c2,20@3 – Sun Fire V40z, bge1
/pci@0,0/pci1022,7450@1/pci8086,1011@1 – Sun Fire X4000 series, bge0 (default)
/pci@0,0/pci1022,7450@1/pci8086,1011@1,1 – Sun Fire X4000 series, bge1
console console – (Single server only) The device name for the server's system console, which may be used to monitor the installation. Default is ttys0 (Linux) and ttya (Solaris).
consolebaud consolebaud – (Single server only) The baud rate for the server's system console. Default is 9600.
kernelparameter kernelparameter – (Linux only) A parameter passed to the kernel during the install process.
Server Configuration Attributes
The following attributes are used to configure the server's network information during the installation. Some attributes can be specified only when installing a single server. The N1 System Manager provides default values for all the attributes that are not single-server specific.
domainname domainname – (Solaris only) A domain assigned to the installed server. If you do not specify this attribute, the management server domain will be used or sun.com.
gateway gateway – A gateway assigned to the installed server.
hostname hostname – (Single server only) A host name assigned to the installed server.
nameserver nameserver – A name server assigned to the installed server.
netmask netmask – A netmask assigned to the installed server.
networkdevice networkdevice – (Single server and Linux only) The server's provisioning network interface after the server is installed. Default is eth0.
This command removes a member from an object or group.
The remove command can be used on the following objects: group, osprofile, role, server, and user.
Type help remove object for details.
This command removes servers from a server group.
Remove one or more servers from a server group:
remove group group server server[,server...] |
Remove all servers from a server group:
remove group group server all |
all – Remove all servers from a server group.
group – The name of a server group.
server – The management name of a provisionable server to remove.
This command removes a distribution group, disk partition, OS update, or a custom installation script from an OS profile. This command cannot be run against a profile that is currently installed on a provisionable server.
Remove a distribution group from an OS profile:
remove osprofile osprofile distributiongroup distributiongroup |
Remove a disk partition information from an OS profile:
remove osprofile osprofile partition partition |
Remove an OS update from an OS profile:
remove osprofile osprofile update update |
Remove a custom installation script from an OS profile:
remove osprofile osprofile script script |
distributiongroup – The name of a distribution group (group of packages) to remove.
osprofile – The name of an OS profile.
partition – The mount point name for the disk partition to remove.
script – The name of the custom installation script to remove.
update – The name of the OS update to remove.
This command removes privileges from a role.
Remove one or more privileges from a role:
remove role role privilege privilege[,privilege...] |
Remove all privileges from a role:
remove role role privilege all |
all – Remove all privileges from the role.
role – The name of a role. You cannot remove privileges from the system default roles: Admin, SecurityAdmin, and ReadOnly. These roles are predefined and cannot be modified.
privilege – The name of a privilege to remove from the role.
This command removes the OS monitoring support from a provisionable server.
Once removed, the OS resource state for the server will become uninitialized. You can use the add server command to add OS monitoring support again.
The base management support cannot be removed.
Removes the OS monitoring support from a provisionable server:
remove server server feature osmonitor |
osmonitor – Removes the OS monitoring support from the server. The OS resource state for the server will become uninitialized.
server – The management name of a server.
This command removes roles from a user.
Remove one or more roles from a user:
remove user user role role[,role...] |
Remove all roles from a user:
remove user user role all |
all – Remove all the roles from the specified user.
role – The name of a role to remove from the user. Use the show user user command to list all the roles currently assigned to a user.
user – The name of a user.
This command reboots provisionable servers.
The reset command can be used on the following objects: group and server.
Type help reset object for details.
This command reboots (power off and power on) a group of provisionable servers. A boot of the operating system might occur depending on the server's configuration.
Reboot a group of provisionable servers:
reset group group [force] [netboot] |
force – Force a power off without a graceful shutdown. If not specified, a graceful shutdown is attempted by default. This option must be used to power off provisionable servers without an OS installed.
group – The name of a server group.
netboot– Force the servers in the group to boot from their default network boot interface. This option enables you to install your servers over the network using an install server setup, which must be configured outside of the N1 System Manager environment.
This command reboots (power off and power on) provisionable servers. A boot of the operating system might occur depending on the server's configuration.
Reboot one or more provisionable servers:
reset server server[,server...] [force] [netboot] |
Reboot all provisionable servers:
reset server all [force] [netboot] |
all – Reboot all provisionable servers.
force – Force a power off without a graceful shutdown. If not specified, a graceful shutdown is attempted by default. This option must be used to power off provisionable servers without an OS installed.
netboot– Force the servers to boot from their default network boot interface. This option enables you to install your servers over the network using an install server setup, which must be configured outside of the N1 System Manager environment.
server – The management name of a provisionable server.
This command changes the attributes on an object or group.
The set command can be used on the following objects: firmware, group, notification, os, osprofile, role, server, session, and user.
Type help set object for details.
This command changes the attributes of a firmware update.
Change various attributes of a firmware update:
set firmware firmware [description description] [model model[,model]] [name name] [type type] [vendor vendor] [version version] |
description – A description for the firmware update.
firmware – The name of a firmware update.
model – The model name of a valid hardware system for the firmware update. Valid values are:
NETRA-240 – Netra 240
SF-V210 – Sun Fire V210
SF-V240 – Sun Fire V240
SF-V250 – Sun Fire V250
SF-V440 – Sun Fire V440
V20z – Sun Fire V20z
V40z – Sun Fire V40z
X4100 – Sun Fire X4100
X4200 – Sun Fire X4200
name – A new name for the firmware update.
type – Specify the type of firmware update. This attribute is required only for the Sun Fire V20z and Sun Fire V40z system firmware updates. Valid values are:
BIOS – Server platform BIOS
PIC – Service processor operator panel
SP – Service processor
vendor – The name of the firmware update vendor. Valid value is Sun.
version – The version number of the firmware update.
This command changes the name of a server group, or changes the locator lights or monitoring status on a group of servers.
Change the name of a server group:
set group group name name |
Refresh the N1 System Manager with the latest settings and status of the group of servers:
set group group refresh |
Enable or disable monitoring on a group of servers:
set group group monitored monitored-state |
Set the polling interval on a monitoring type for a specific group of servers:
set group group monitor monitor interval interval |
Turn the locator light on or off on a group of servers:
set group group locator locator-state |
Set the threshold values for an OS resource attribute on a group of servers:
set group group threshold threshold [criticallow value] [criticalhigh value] [warninglow value] [warninghigh value] |
group – The name of a server group.
interval – Set the polling interval for monitoring, in seconds. Valid values are integers above zero.
locator-state – Turn the locator light on or off on the group of servers. Valid values are true (on) and false (off).
monitor – Specify a type of monitoring on the group of servers in order to set its polling interval. Valid values are hardwarehealth, osresources, and network.
monitored-state – Enable or disable monitoring on the group of servers. Valid values are true (enable) and false (disable)
name – A new name for the server group.
refresh – Refresh the management server with the latest settings and status of the group of servers. This status includes monitoring information, currently installed software, and other details.
threshold– Choose an OS resource attribute for which to set one or multiple threshold values. Valid values are:
cpustats.loadavg1min – System load expressed as average number of queued processes over 1 minute.
cpustats.loadavg5min – System load expressed as average number of queued processes over 5 minutes.
cpustats.loadavg15min – System load expressed as average number of queued processes over 15 minutes.
cpustats.pctusage – Overall CPU usage percentage.
cpustats.pctidle – Overall CPU idle percentage.
memusage.pctmemused – Percentage of memory in use.
memusage.pctmemfree – Percentage of memory free.
memusage.mbmemused – Memory in use (MBytes).
memusage.mbmemfree – Memory free (MBytes).
memusage.pctswapused – Percentage of swap space in use.
memusage.mbswapfree – Free swap space (MBytes).
fsusage.pctused – Percentage of file system space in use.
value– Set a threshold value for an OS resource attribute on the group of servers. Valid values for the criticallow, criticalhigh, warninglow, and warninghigh thresholds depend on the attribute. For attributes measuring percentages, the valid value range is 0–100. A value of none disables monitoring of the attribute for that threshold.
This command changes the name, description, or notification destination for a notification rule.
Change the name, description, or notification destination for a notification group:
set notification notification [name name] [description description] [destination destination] |
description – A new description for the notification rule.
destination – A new destination where the notification should be sent. The new destination must match the notification rule's type, which was set when the rule was created. Valid values are:
email-addresses – One or more email addresses separate by commas.
snmp-host[:port] – An SNMP host. snmp-host is a valid SNMP host name and port is a valid port on the host.
name – A new name for the notification rule.
notification – The name of a notification rule.
This command changes the name of an OS distribution.
Change the name of an OS distribution.
set os os name name |
name – A new name for the OS distribution.
os – The name of an OS distribution.
This command changes the configuration of an OS profile.
Change the configuration of a Solaris OS profile.
set osprofile osprofile [solaris-profile-attributes] |
Change the configuration of a Red Hat Linux OS profile.
set osprofile osprofile [redhat-profile-attributes] |
Change the configuration of a SUSE Linux OS profile.
set osprofile osprofile [SUSE-profile-attributes] |
osprofile – The name of an OS profile.
Solaris Profile Attributes
description description – Specify a description for the OS profile.
flar flar –Specify the name of a Flash archive file. A fully qualified path is required.
language language – Specify the default language for the installation. Default value is en_us. Valid values for a Solaris profile are C, en_US.ISO8859-15, en_US.ISO8859-1, and en_US.
ldap ldap – Configure LDAP on the server. Valid values are true and false.
ldapserver ldapserver – Specify the name of an LDAP server.
ldapbasename ldapbasename – Specify the base name of an LDAP server.
name name – Change the name of the OS profile.
nis nis – Enable NIS on the installed server. Valid values are enabled and disabled.
nisdomain nisdomain – Specify a NIS domain for the installed server.
nisserver nisserver – Specify a NIS server for the installed server, or set to broadcast for the installation to automatically find an available NIS server.
rootpassword rootpassword – Change the root password for the installed server.
timezone timezone – Specify the time zone for the installation. Default value is gmt. Valid values for a Solaris profile are provided by the directories and files in the /usr/share/lib/zoneinfo directory on a Solaris system. The timezone value is the name of the path relative to the /usr/share/lib/zoneinfo directory. For example, the timezone value for Mountain Standard Time in the United States is US/Mountain. The timezone value for Japan is Japan.
Red Hat Linux Profile Attributes
clearmbr clearmbr – Clear the master boot record on server. Valid values are true and false.
description description – Specify a description for the OS profile.
existingpartition existingpartition – Action to take on existing partitions on the server during the installation. Valid values are:
all – Default value. Remove all existing partitions.
linux – Remove all Linux partitions.
preserve – Preserve all existing partitions.
initdisklabel initdisklabel – Initialize disk label. If enabled, the first sector of disk that contains geometry and partition information will be initialized during the installation. Valid values are true and false.
language language – Specify the default language for the installation. Default value is en_us. Valid values for a Red Hat profile are cs_CZ, da_DK, de_DE, en_US, es_ES, fr_FR, is_IS, it_IT, ja_JP.eucJP, ko_KR.eucKR, nl_NL, no_NO, pt_PT, ru_RU.k0I8r, sl_SI, sv_SE, uk_UA,zh_CN.GB2312, and zh_TW.Big5.
ldap ldap – Configure LDAP on the server. Valid values are true and false.
ldapserver ldapserver – Specify the name of an LDAP server.
ldapbasename ldapbasename – Specify the base name of an LDAP server.
md5 md5 – Enable MD5 checksum. If enabled, the integrity of the files and messages will be verified during the installation. Valid values are true and false.
name name – Change the name of the OS profile.
nis nis – Enable NIS on the installed server. Valid values are enabled and disabled.
nisdomain nisdomain – Specify a NIS domain for the installed server.
nisserver nisserver – Specify a NIS server for the installed server, or set to broadcast for the installation to automatically find an available NIS server.
rebootafterinstall rebootafterinstall – Reboot system after install. Valid values are true and false.
rootpassword rootpassword – Change the root password for the installed server.
shadowpassword shadowpassword – Enable a shadow password. Valid values are true and false.
timezone timezone – Specify the time zone for the installation. Default value is gmt. Valid values for a Red Hat profile are any of the time zones listed by the timeconfig command.
SUSE Linux Profile Attributes
description description – Specify a description for the OS profile.
ftpproxy ftpproxy – Specify an FTP proxy server for the installed server. The proxy attribute must be enabled for this attribute to be recognized. You can specify an IP address or host name of the HTTP proxy server and you must include the port number. If you specify a proxy server by its host name, your name server must be set up accordingly. Examples: http://129.101.1.240:3128 or http://proxy.provider.com:3128
httpproxy httpproxy – Specify an HTTP proxy server for the installed server. The proxy attribute must be enabled for this to be recognized. You can specify an IP address or hostname of the HTTP proxy server. You must include the port number. If you specify a proxy server by its host name, your name server must be set up accordingly. Examples: http://129.101.1.240:3128 or http://proxy.provider.com:3128
language language – Specify the default language for the installation. Default value is en_us. Valid values for a SUSE profile are cs_CZ, da_DK, de_DE, en_US, es_ES, fr_FR, is_IS, it_IT, ja_JP.eucJP, ko_KR.eucKR, nl_NL, no_NO, pt_PT, ru_RU.k0I8r, sl_SI, sv_SE, uk_UA,zh_CN.GB2312, and zh_TW.Big5.
ldap ldap – Configure LDAP on server. Valid values are true and false.
ldapserver ldapserver – Specify the name of an LDAP server.
ldapbasename ldapbasename – Specify the base name of an LDAP server.
name name – Change the name of the OS profile.
nis nis – Enable NIS on the installed server. Valid values are enabled and disabled.
nisdomain nisdomain – Specify a NIS domain for the installed server.
nisserver nisserver – Specify a NIS server for the installed server, or set to broadcast for the installation to automatically find an available NIS server.
proxy proxy – Enable or disable proxy servers on the installed server. Valid values are enabled (default) and disabled. Use the ftpproxy and httpproxy attributes to specify the proxy servers.
rebootafterinstall rebootafterinstall – Reboot the system after install. Valid values are true and false.
rootpassword rootpassword – Change the root password for the installed server.
timezone timezone – Specify the time zone for the installation. Default value is gmt. Valid values for a SUSE profile are any of the time zones listed by the timeconfig command.
This command changes the description of a role.
Change the description for a role:
set role role description description |
role – The name of a role.
description – A new description for the role.
This command changes the configuration information of a provisionable server or refreshes the N1 System Manager with the server's current settings and status.
Change the configuration of a provisionable server:
set server server configuration-attributes |
Refresh the N1 System Manager with a server's current settings and status:
set server server refresh |
Change the IP address and the SSH credentials used for OS monitoring on the provisionable server:
set server server agentip agentip agentssh agentssh |
Set the SNMP credentials used for OS monitoring on the provisionable server:
set server server agentsnmp agentsnmp |
Enable or disable monitoring on a provisionable server:
set server server monitored monitored-state |
Set the polling interval on a monitoring type for a server:
set server server monitor monitor interval interval |
Turn the locator light on or off on a provisionable server:
set server server locator locator-state |
Set the threshold values for an OS resource attribute on a provisionable server:
set server server threshold threshold [criticallow value] [criticalhigh value] [warninglow value] [warninghigh value] |
agentip – Change the IP address used for OS monitoring on the provisionable server, which should be the IP address of the provisioning network interface on the server.
agentsnmp – Specify the SNMP credentials used for OS monitoring on the provisionable server. The agentsnmp format is a read community string for the SNMP credentials: read-community.
agentssh – Specify the SSH credentials used for OS monitoring on the provisionable server. The SSH user must have root access on the provisionable server. The agentssh format is a user name/password pair for SSH credentials: ssh-username/ssh-password.
interval – Set the polling interval for monitoring, in seconds. Valid values are integers above zero.
locator-state – Turn the server's locator light on or off. Valid values are true (on) and false (off).
monitor – Specify a monitoring type on the server in order to set its polling interval. Valid values are hardwarehealth, osresources, and network.
monitored-state– Enable or disable monitoring on the provisionable server. Valid values are true (enable) and false (disable).
refresh – Refresh the management server with the server's current settings and status. This includes monitoring information, currently installed software, and other details.
server – The management name of a server.
threshold– Choose an OS resource attribute for which to set one or multiple threshold values. Valid values are:
cpustats.loadavg1min – System load expressed as average number of queued processes over 1 minute.
cpustats.loadavg5min – System load expressed as average number of queued processes over 5 minutes.
cpustats.loadavg15min – System load expressed as average number of queued processes over 15 minutes.
cpustats.pctusage – Overall CPU usage percentage.
cpustats.pctidle – Overall CPU idle percentage.
memusage.pctmemused – Percentage of memory in use.
memusage.pctmemfree – Percentage of memory free.
memusage.mbmemused – Memory in use (MBytes).
memusage.mbmemfree – Memory free (MBytes).
memusage.pctswapused – Percentage of swap space in use.
memusage.mbswapfree – Free swap space (MBytes).
fsusage.pctused – Percentage of file system space in use.
value– Set a threshold value for an OS resource attribute on a provisionable server. Valid values for the criticallow, criticalhigh, warninglow, and warninghigh thresholds depend on the attribute. For attributes measuring percentages, the valid value range is 0–100. A value of none disables monitoring of the attribute for that threshold.
Configuration Attributes
agentsnmp agentsnmp – Specify the SNMP credentials for OS monitoring on the provisionable server. The agentsnmp format is a read community string for the SNMP credentials: read-community.
ip ip – Change the management network IP address for the server.
ipmi ipmi – Change the IPMI credentials for the server's management network IP address. The ipmi value is an IPMI password.
name name – Change the name of the server.
note note – Change the notes for the server.
snmp snmp – Change the SNMP credentials for the server's management network IP address. The snmp format is a read community string for the SNMP credentials: read-community.
ssh ssh – Change the SSH credentials for the server's management network IP address. The sshformat is a user name/password pair for SSH credentials: ssh-username/ssh-password.
This command changes the user's role or the output format for the current session.
Change the user's role for the current session:
set session role role |
Change the output format for the current session:
set session output output |
output – The output format for the current session. Valid values are text (default), html, or xml.
role – The name of the new role.
This command changes the default role for a user.
Change the default role for a user:
set user user defaultrole defaultrole |
defaultrole – The name of the new default role for the user.
user – The name of a user.
This command lists summary or detailed information about an object or group.
The show command can be used on the following objects: firmware, group, job, log, notification, os, osprofile, privilege, role, server, session, update, and user.
Type help show object for details.
This command lists all the copied firmware updates or detailed information about a firmware update.
List all the firmware updates:
show firmware [all] |
Filter the list of firmware updates:
show firmware [model model] [type type] [vendor vendor] |
List detailed information about a firmware update:
show firmware firmware |
all – List all the firmware updates.
firmware – The name of a firmware update.
model – Filter the list of firmware updates by model name. Valid values are:
NETRA-240 – Netra 240
SF-V210 – Sun Fire V210
SF-V240 – Sun Fire V240
SF-V250 – Sun Fire V250
SF-V440 – Sun Fire V440
V20z – Sun Fire V20z
V40z – Sun Fire V40z
X4100 – Sun Fire X4100
X4200 – Sun Fire X4200
type – Filter the list of firmware updates. This filter is available only for the Sun Fire V20z and Sun Fire V40z system firmware updates. Valid values are:
BIOS – Server platform BIOS
PIC – Service processor operator panel
SP – Service processor
vendor – Filter the list of firmware updates based on the vendor.
This command lists all server groups or detailed information about a specific server group.
List all the server groups:
show group [all] |
List detailed information about a server group:
show group group |
all – List all the server groups.
group – The name of a server group.
This command lists all jobs, detailed information about a specific job, or jobs based on a specified filter.
List detailed information about a specific job:
show job job |
List all the jobs in descending order:
show job all |
Filter the listing of the jobs:
show job [count count] [endbefore endbefore] [endafter endafter] [owner owner] [startbefore startbefore] [startafter startafter] [state state] [target server] [type type] |
all – List all the jobs in descending order.
count– A number specifying how many jobs to list in descending order. Default is 500.
endafter – List jobs finished after a specific date. See the detailed date format below. Example: 2005-07-20T11:53:04
endbefore – List jobs finished before a specific date. See the detailed date format below. Example: 2005-07-20T11:53:04
job – A job identification number.
server – The management name of a server. List all jobs based on a specific server.
startafter – List jobs started after a specific date. See the detailed date format below. Example: 2005-07-20T11:53:04
startbefore – List jobs started before a specific date. See the detailed date format below. Example: 2005-07-20T11:53:04
state – List all jobs based on a specific job state:
completed – List completed jobs.
error – List jobs that ended with errors.
notstarted – List jobs that have not started.
preflight – List jobs that are in a pre-run, test state.
pendingstop – List jobs that a user has canceled. A job must finish the current step on all servers before it can be canceled, so a job is in this state during that time period.
running – List currently running jobs.
stopped – List canceled or stopped jobs.
timedout – List jobs that have timed out and not finished.
warning – List jobs completed with warnings.
type – List all jobs based on a specific job type:
addbase – Add base management support
addosmonitor – Add OS monitoring support
createos – Create OS distribution from CD/DVD media or ISO files
deletejob – Job deletion
discover – Server discovery
loadfirmware – Load firmware update
loados – Load OS
loadupdate – Load OS update
refresh – Server refresh
removeosmonitor – Remove OS monitoring support
reset – Server reboot
setagentip – Modify OS monitoring support
start – Server power on
startcommand – Remote command execution
stop – Server power off
unloadupdate – Unload OS update
owner – The name of a user. List all jobs based on a specific user.
Date Format
The following date format based on the XML Schema and it is used for the endbefore, endafter, startbefore, and startafter options:
[CC]YY[-MM[-DD[Thh[:mm[:ss[Z]]]]]]
CC – Century (a year divided by 100 and truncated to an integer) as a decimal number [00-99]. For example, CC is 19 for the year 1988 and 20 for the year 2007.
YY – Last two digits of the year number. If century (CC) is not specified, then values in the range 69-99 shall refer to years 1969 to 1999 inclusive, and values in the range 00-68 shall refer to years 2000 to 2068, inclusive.
MM – Month number.
DD – Day number in the month. The DD format can have values from 1 to 31 depending on the month and year.
T – Date/time separator.
hh – Hour number (24 hour system). The hh format can have values from 0 to 23.
mm – Minute number. The mm format can have values from 0 to 59.
ss – Second number. The ss format can have values from 0 to 60.
Z – Indicates Coordinated Universal Time (UTC).
This command lists all known events from the N1 System Manager or provisionable servers, detailed information about a specific event, or events based on a specified filter.
List detailed information about a specific event:
show log log |
List the events in descending order. By default, the last 500 events are listed:
show log [count count] |
Filter the listing of the events:
show log [after after] [before before] [count count] [severity severity] |
after – List events after a specified date. See the detailed date format below. Example: 2005-07-20T11:53:04
before – List events before a specified date. See the detailed date format below. Example: 2005-07-20T11:53:04
count– A number specifying how many events to list in descending order. The default is 500.
log – An event identification number.
severity – List events with a specific event severity. Valid values are:
unknown
other
information
warning
minor
major
critical
fatal
Date Format
The following date format based on the XML Schema and it is used for the after and before options:
[CC]YY[-MM[-DD[Thh[:mm[:ss[Z]]]]]]
CC– Century (a year divided by 100 and truncated to an integer) as a decimal number [00-99]. For example, CC is 19 for the year 1988 and 20 for the year 2007.
YY – Last two digits of the year number. If century (CC) is not specified, then values in the range 69-99 shall refer to years 1969 to 1999 inclusive, and values in the range 00-68 shall refer to years 2000 to 2068, inclusive.
MM – Month number.
DD – Day number in the month. The DD format can have values from 1 to 31 depending on the month and year.
T – Date/time separator.
hh – Hour number (24 hour system). The hh format can have values from 0 to 23.
mm – Minute number. The mm format can have values from 0 to 59.
ss – Second number. The ss format can have values from 0 to 60.
Z – Indicates Coordinated Universal Time (UTC).
This command lists all notification rules or detailed information about a specific notification rule.
List all the notification rules:
show notification [all] |
List detailed information about a specific notification rule:
show notification notification |
all – List all the notification rules.
notification – The name of a notification rule.
This command lists all available OS distributions from the N1 System Manager or detailed information about a specific OS distribution.
List all the available OS distributions:
show os [all] |
List the available OS distributions of a specific OS type:
show os type |
List detailed information about a specific OS distribution, which includes the list of distribution groups.
show os os |
all – List all the available OS distributions.
os – The name of an OS distribution.
type– The type of OS distribution. Valid values are redhat, solaris, and sles9 (SUSE LINUX Enterprise Server 9).
This command lists all available OS profiles or detailed information about a specific OS profile.
List all the available OS profiles:
show osprofile [all] |
List the available OS profiles for a specific OS distribution:
show osprofile os os |
List details about a specific OS profile:
show osprofile osprofile |
all – List all the available OS profiles.
osprofile – The name of an OS profile.
os – The name of an OS distribution to filter on.
This command lists all available privileges or detailed information about a specific privilege.
List all the available privileges:
show privilege [all] |
List detailed information about a specific privilege:
show privilege privilege |
all – List all the available privileges.
privilege – The name of a privilege.
This command lists all available roles or the privileges for a specific role.
List all the available roles and the privileges assigned to them:
show role [all] |
List the privileges for a specific role:
show role role |
all– List all the available roles and the privileges assigned to them.
role – The name of a role.
This command lists all the available provisionable servers, a filtered list of provisionable servers, or detailed information for a specific server.
List all the available provisionable servers:
show server [all] |
List details for a provisionable server.
show server server |
Filter the list of provisionable servers based on various states:
show server [health health] [monitored monitored-state] [power power] [utilization utilization] |
all – List all the available provisionable servers.
health – Filter the provisionable servers based on a hardware health status. Valid values are:
good – The server hardware is working properly.
unknown – The server is not returning any hardware health status information.
unreachable – The server cannot be contacted for hardware health status information. This state is most often caused by a network problem.
nonrecoverable – The server has completely failed; recovery is not possible.
critical – A fault condition has occurred on the server and corrective action is required.
warning – A potential or impending fault condition has been detected on the server. Action should be taken to prevent the problem from becoming more serious.
unmonitored – The server is not returning hardware health status information because monitoring has been disabled.
monitored-state – List the provisionable servers based on a monitored state. Valid values are true (list provisionable servers with monitoring enabled) and false (list provisionable servers with monitoring disabled).
server – The management name of a server.
power – Filter the provisionable servers based on a specific power state. Valid values are:
on – The server is powered on and running.
standby – The server is powered down, but it is still responsive to commands, for example, booting.
unknown – The server is not returning any power status information.
unreachable – The server cannot be contacted for power status information. This state is most often caused by a network problem.
utilization – Filter the provisionable servers based on a specific OS resource state. Valid values are:
good – The server with booted OS is working properly.
unknown – The server is not returning any OS resource status information.
unreachable – The server cannot be contacted for OS resource status information. This state is most often caused by a network problem.
critical – A fault condition has occurred on the server, and corrective action is required.
warning – A potential or impending fault condition has been detected on the server. Action should be taken to prevent the problem from becoming more serious.
unmonitored – The server is not returning OS resource status information because monitoring has been disabled.
uninitialized – The server is not sending OS resource status information because the OS monitoring support has not been added.
This command lists the user's current role in the session.
List the user's current role in the session:
show session |
This lists all the OS updates or detailed information about a specific OS update.
List all the available OS updates:
show update [all] |
Filter the list of OS updates available for a specific OS distribution:
show update os os |
List detailed information about a specific OS update:
show update update |
all – List all the available OS updates.
os – The name of an OS distribution by which to filter list.
update – The name of an OS update.
This command lists all the available users or detailed information about a specific user.
List all the available users:
show user [all] |
List detailed information about a specific user, including the user's assigned roles and default role:
show user user |
all – List all the available users.
user – The name of a user.
This command enables an object or issues a command. For example, you can power on and boot provisionable servers or enable a notification rule.
The start command can be used on the following objects: group, notification, and server.
Type help start object for details.
This command powers on and boots a group of provisionable servers or issues a remote command on a group of servers. You can view the output of the remote command from the associated job that is started.
Power on and boot a group of provisionable servers:
start group group [netboot] |
Issue a remote command on a group of servers:
start group group command "command" [agentssh agentssh] [timeout timeout] |
agentssh – Override SSH credentials on the provisionable server for the remote command.
command – A UNIX command to run on the group of servers. The command must be surrounded by quotes. You can view the output of the command from the associated job that is started.
group – The name of a server group.
netboot – Force the servers in the group to boot from their default network boot interface. This option enables you to install your servers over the network using an install server setup, which must be configured outside of the N1 System Manager environment.
timeout– Number of seconds command can run before timing out.
This command enables or tests a notification rule.
Enable a notification rule:
start notification notification |
Send a test notification message based on the destination and type of the rule:
start notification notification test |
notification – The name of a notification rule.
test – Test the notification rule.
This command powers on and boots provisionable servers or issues a remote command remotely on the provisionable servers. You can view the output of the remote command from the associated job that is started.
Power on and boot all provisionable servers:
start server all [netboot] |
Power on and boot one or more provisionable servers:
start server server[,server...] [netboot] |
Issue a remote command remotely on one or more servers:
start server server[,server] command "command" [agentssh agentssh] [timeout timeout] |
Issue a remote command remotely on all servers:
start server all command "command" [agentssh agentssh] [timeout timeout] |
agentssh – Override SSH credentials on the provisionable server for the remote command.
all – Power on or issue a remote command on all provisionable servers.
command – A UNIX command to run on the provisionable server. The command must be surrounded by quotes. You can view the output of the command from the associated job that is started.
netboot – Force the servers to boot from their default network boot interface. This option enables you to install your servers over the network using an install server setup, which must be configured outside of the N1 System Manager environment.
server – The management name of a provisionable server.
timeout– Number of seconds the command can run before timing out.
This command disables an object. For example, you can shut down and power off a provisionable server or cancel a job.
The stop command can be used on the following objects: group, job, notification, and server.
Type help stop object for details.
This command shuts down and powers off a group of provisionable servers.
Shut down and power off a group of provisionable servers:
stop group group [force] |
force – Force a power off without a graceful shutdown. If not specified, a graceful shutdown is attempted by default. This option must be used to power off provisionable servers without an OS installed.
group – The name of a server group.
This command stops a job from running. When a job is stopped, it is in the aborted state.
Stop a single job from running.
stop job job |
job – A job identification number.
This command disables a notification rule.
Disable a notification rule:
stop notification notification |
notification – The name of a notification rule.
This command shuts down and powers off provisionable servers.
Shut down and power off one or more servers:
stop server server[,server...] [force] |
Shut down and power off all servers:
stop server all [force] |
all – Shut down and power off all provisionable servers.
force – Force a power off without a graceful shutdown. If not specified, a graceful shutdown is attempted by default. This option must be used to power off provisionable servers without an OS installed.
server – The management name of a provisionable server.
This command uninstalls software from provisionable servers or a group of servers.
The unload command can be used on the following objects: group and server.
Type help unload object for details.
This command uninstall an OS update from a group of provisionable servers.
Uninstall an OS update from a group of provisionable servers:
unload group group update update |
group – The name of a server group.
update – The name of an OS update. Note that if this user–specified name is not found, the command will try to uninstall an OS update with a matching file name. The show update command enables you to list an OS update's corresponding file name.
This command uninstalls an OS update from provisionable servers.
Uninstall an OS update from one or more provisionable servers:
unload server server[,server...] update update |
server – The management name of one or more servers.
update – The name of an OS update. If this user–specified name is not found, the command will try to uninstall an OS update with a matching file name. The show update command enables you to list an OS update's corresponding file name.
This section describes the objects that can be managed by the N1 System Manager commands.
The available objects are listed in the following table.
Object |
Definition |
---|---|
firmware |
A firmware update for the provisionable servers. |
group |
A group of provisionable servers. |
job |
An asynchronous action initiated and tracked by a user to perform some management task. |
log |
An event generated from a provisionable server or the N1 System Manager. |
notification |
A notification rule created by a user to define when, where, and how to notify an external source, such as a user, of a N1 System Manager event. |
os |
A binary distribution of an OS, also known as an OS distribution. |
osprofile |
An OS profile, which is a configuration file that defines how to install an OS distribution. |
privilege |
A predefined set of permissions enabling a user to perform certain operations within the N1 System Manager. A privilege may be granted to a user by assigning it to a role and then assigning the role to the user. |
role |
A set of privileges that can be assigned to a N1 System Manager user. The N1 System Manager provides three predefined roles: ReadOnly, SecurityAdmin, and Admin. Authorized users may create customized roles, but users cannot modify the predefined roles. |
server |
A provisionable server, which is a server that has been discovered by and can be managed by the N1 System Manager. |
session |
The role and other contextual information that is associated with every active user session. A separate user session is created for each user logged into the browser interface and n1sh command line interface. The browser interface and the browser interface's command line share a common session and hence have a common session role. |
update |
An OS update, such as a patch or package for the Solaris operating system or an RPM for the Red Hat operating system. |
user |
A person who is authorized to log into the N1 System Manager. |
The firmware object is a firmware update for the provisionable servers.
The following commands are available for the firmware object: create, delete, set, and show. You must use the load server or load group commands to install a firmware update.
Type help command object for details on each command.
The group object is a group of provisionable servers.
The following commands are available for the group object: add, create, delete, load, remove, reset, set, show, start, stop, and unload.
Type help command object for details on each command.
The job object is an asynchronous action that is initiated and tracked by a user to perform some management task.
The following commands are available for the job object: delete, show, and stop.
Type help command object for details on each command.
The log object is an event generated from a provisionable server or the N1 System Manager.
The following commands are available for the log object: show.
Type help command object for details on each command.
The notification object is a notification rule created by a user to define when, where, and how to notify an external source, such as a user, of a N1 System Manager event.
The following commands are available for the notification object: create, delete, set, show, start, and stop.
Type help command object for details on each command.
The os object is a binary distribution of an OS, also known as an OS distribution.
The following commands are available for the os object: create, delete, set, and show.
Type help command object for details on each command.
The osprofile object is a configuration file that defines how to install an OS distribution.
The following commands are available for the osprofile object: add, create, delete, remove, set, and show. You must use the load server or load group commands to install an OS profile.
Type help command object for details on each command.
The privilege object is a predefined set of permissions enabling a user to perform certain operations within the N1 System Manager. A privilege may be granted to a user by assigning it to a role and then assigning the role to the user.
The following commands are available for the privilege object: show. You must use the add role and remove role commands to add and remove privileges from a role.
Type help command object for details on each command.
The role object is a set of privileges that can be assigned to a N1 System Manager user. The N1 System Manager provides three predefined roles: ReadOnly, SecurityAdmin, and Admin. Authorized users may create customized roles, but they cannot modify the predefined roles.
The following commands are available for the role object: add, create, delete, remove, set, and show. You must use the add user and remove user commands to add and remove roles from a user.
Type help command object for details on each command.
The server object is a provisionable server, which is a server that has been discovered by and can be managed by the N1 System Manager.
The following commands are available for the server object: add, connect, delete, load, remove, reset, show, start, stop, and unload. You must use the discover command to discover a provisionable server.
Type help command object for details on each command.
The session object is the role and other contextual information that is associated with every active user session. A separate user session is created for each user logged into the browser interface and n1sh command line interface. The browser interface and the browser interface's command line share a common session and hence have a common session role.
The following commands are available for the session object: set and show.
Type help command object for details on each command.
The update object is an OS update, such as a patch or package for the Solaris operating system or an RPM for the Red Hat operating system.
The following commands are available for the update object: create, delete, and show. You must use the load server or load group commands to install an OS update.
Type help command object for details on each command.
The user object is a person who is authorized to log in to the N1 System Manager.
The following commands are available for the user object: add, create, delete, remove, set, and show.
Type help command object for details on each command.