AI team,
Please review this 1st draft of a man page for installadm, the
AI utility. Send edits as inline comments in this email sometime this week.
Also, I need volunteers to provide some examples of the core
subcommands for the examples section in this page. For an example,
I need a short description of that command is doing,
the command line example and, where appropriate, the output example.
Barbara
System Administration Commands installadm(1M)
NAME
installadm - Utility for administering the Auto
Installer tool by publishing OSInstall services,
setting up DHCP network, configuring client, and
publishing AI manifests.
SYNOPSIS
/usr/sbin/installadm
installadm
installadm create-service [-d] [-u][-b bootfile]
[-D DHCP_server][-n service_name] [-f dhcp_file]
[-s path_to_source_image] target_directory
installadm delete-service [-x] service_name
installadm set [-p name=value] [-n service_name]
installadm list [-n service_name]
installadm start [-n service_name]
installadm stop [-n service_name]
installadm add [-c ai_criteria] [-n service_name]
installadm remove [-c ai_criteria] [-n service_name]
installadm create-client [-e client_addr]
[-n service_name] [-t http/nfs]
installadm delete-client [-e client_addr]
installadm version
installadm help
DESCRIPTION
The installadm utility is part of the Automated
Installer (AI) tool. This utility enables users to
accomplish the following tasks:
- Set up services
- Set up images
- Set up DHCP server
- Update DHCP server
- Set up or remove client
- Add or delete manifests
- Start or stop services
- List services
- List manifests for a service
SUBCOMMANDS AND OPTIONS
The installadm command has the subcommands
and options listed below. Also see EXAMPLES
below.
installadm
Displays command usage.
installadm create-service [-d] [-u][-b bootfile]
[-D DHCP_server][-n service_name] [-f dhcp_file]
[-s path_to_source_image] target_directory
Publishes the OSInstall service. Only a source image
and a target directory are required for basic setup.
The command provides the following functionality:
- Sets up the OSInstall service image.
- Copies source image to service location.
- Translates a non-standard distribution to
OSInstall service layout.
- Starts AI manifest web server.
- Creates a bootfile.
- Creates/tftpboot entries for bootfile.
- Publishes a default service, named
_default._OSInstall._tcp.local
- Registers a default AI manifest with AI HTTP web
server.
- Registers a default SC manifest with AI HTPP web
server.
- Adds DHCP macro entries for services published.
Note the following specifications:
- As default, both image and service are created.
- If existing service name (SVCname) is provided, only
image is created.
- If source image (SRCimage) is not provided, and
target directory contains a valid net image, then new
service is created with existing net image.
- One net image can have multiple services.
- Multiple net images can use the same service.
- By default DHCP server is configured. DHCP parameters
are provided by DHCP file or entered by user
interactively.
- An already-configured DHCP server on the same system
is updated.
- If DHCP is running on a remote system, update can
happen through secure shell. User must provide
authentication.
-d
Makes this new service the default service.
##NOT NOVEMBER -u
## Publishes service by using unicast DNS.
-b bootfile
Users this bootfile for the service. If bootfile
doesn't exist, it is created.
-n service_name
Uses this service name instead of default service name.
If a service of this name already exists, user is
warned, and new service is created and named
<service_name><n>.
-f dhcp_file
Sets up a new DHCP server. Specifies a DHCP file which
contains information including range of IP addresses,
router, and netmask.
-D DHCP_server
Updates the DHCP server at this address with
appropriate macro. Secure shell is used to contact a
remote server. User must provide authentication.
-s path_to_source_image
Required: Specifies location of source AI images to use
for setting up OSInstall service.
target_directory
Required: Specifies location to set up image.
installadm delete-service [-x] service_name
Deletes a published service. Accomplishes the following:
- Removes service from the network.
- Removes bootfile and associated /tftpboot entries.
- Stops the AI web server that is running for this
service.
- Removes the manifests and web server configuration
for this service.
- If permitted, removes the DHCP macro for this service.
Or, advises user to remove macro manually.
- With -x option, removes the image. If the image is
removed, any IP address associated with this image are
reset.
-x
Removes the image and makes free space available.
service_name
Required: Specifies service name.
installadm set [-p name=value] [-n service_name]
Updates default manifests associated with a published
service.
-p <name>=<value>
Required: Specifies path for manifests.
Name is the string 'manifest'.
Value is the path of the file with criteria and
pointers to AI manifest and SC manifest.
-n service_name
Required: Specifies the name of the published service.
installadm list [-n service_name]
Lists published services that are running on a system.
Or, with -n option, lists published manifests
associated with a specified service.
-n service_name
Lists all manifests associated with the specified
service.
installadm start [-n service_name]
Starts or restarts a specified service. Starts or
restarts the web server associated with the service.
-n service_name
Required: Specifies name of the service to be started.
installadm stop [-n service_name]
Stops a specified service. Stops the web server
associated with the service.
-n service_name
Required: Specifies name of the service to be started.
installadm add [-c ai_criteria] [-n service_name]
Publishes manifests to be associated with a specific
service, independently from publishing the service.
-c ai_criteria
Required: Specifies path name to a file that contains
the criteria list with pointers to AI manifest and to
SC manifest.
-n service_name
Required: Specifies name of service this manifest is to
be associated with.
installadm remove [-c ai_criteria] [-n service_name]
Remove a manifest that was published with a specific
service.
-c ai_criteria
Required: Specifies path name to a file that contains
the criteria list with pointers to AI manifest and to
SC manifest.
-n service_name
Required: Specifies name of service this manifest is to
be associated with.
installadm create-client [-e client_addr]
[-n service_name] [-t http/nfs]
Accomplishes optional setup tasks for a specified
client, in order to provide custom client settings that
vary from the default settings used by the installadm
create-service command. Enables user to specify
services and manifests for that client:
- Specifies installation service for that client.
- Creates bootfile and /tftpboot entries. Bootfile name
is derived from MAC address.
- Sets up DHCP macro, if it doesn't exist, with
bootfile information.
-e client_addr
Required: Specifies MAC address for client.
-n service_name
Required: Specifies service for client to use for
installation.
-t http/nfs
Optional: Enter either http or nfs. Specifies transport
protocol for accessing remote archive data. HTTP is
default protocol.
installadm delete-client [-e client_addr]
Deletes an existing client's non-default information
that was previously set up using the installadm create-
client command.
-e client_addr
Required: Specifies MAC address for the client.
## NOT FOR NOVEMBER? installadm help
## NOT FOR NOVEMBER? installadm version
USAGE
## What other basic information needs to be included here?
EXAMPLES
## Add examples for key subcommands. Include description of task, command line
example, and output example.
EXIT STATUS
## Add any error message information here.
ATTRIBUTES
## Specify name of package that includes this man page?
## Specify path to man page in package?
## Comment on stability of the package?
SEE ALSO
## Add cross reference to the AI article in the package and to Open Solaris
Getting Started document.
NOTES
## TBD
OpenSolaris 2008.011 Last Change September 15, 2008
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://mail.opensolaris.org/pipermail/caiman-discuss/attachments/20080915/ff97d647/attachment.html>
