Part III Sun Internet Administrator

Sun^TM Internet Administrator^TM 1.1 man pages. These man pages are located in /opt/SUNWixamc/man.

man Pages(1m): Maintenance Commands

mcIntro(1M)

NAME | DESCRIPTION | ATTRIBUTES | NOTES

NAME

mcIntro- Introduction to the Sun Internet Administrator software command-line utilities for Solaris ISP Server

DESCRIPTION

The man pages offer detailed instruction and examples on the options and subcommands for each utility. The command line utilities are available to initialize Sun Internet Administrator entries in Sun Directory Services, register the services and service hosts with Sun Internet Administrator, and create administrators for the registered services.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamm
Availability	SUNWispm
Interface Stability	Evolving

NOTES

mcadd(1m)

Adds a specified registered service to Sun Internet Administrator. This command must be run on the host where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin

mcaddadm(1m)

Creates an administrator in Sun Internet Administrator and authorizes the administrator to services specified by you. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin

mcadmpwd(1m)

Sets the password for an existing administrator in Sun Internet Administrator. This command can be used to change an existing password. You require root access to run this command. This command is located in /opt/SUNWixamc/sbin

mcdsinit(1m)

Makes initial service entries for Sun Internet Administrator in Sun^TM Directory Services. You require root access to run this command. This command is located in /opt/SUNWixamc/sbin

mcdsclean(1m)

Checks to see if registered services are still available for management from Sun Internet Administrator, and if not found, removes the service entries in the directory services. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin.

mchelp(1m)

Displays the release version of Sun Internet Administrator installed on the system and all command line utilities associated with it. This command must be run on the machine where Sun Internet Administrator is installed. This command is located in /opt/SUNWisp/SUNWixamr/

mchostls(1m)

Lists the package name and service name for each service installed and registered on the specified host. Use this utility to discover what services are available for management through Sun Internet Administrator. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin.

mcreg(1m)

Register a service application to make it available for management through Sun Internet Administrator. Records the service's user interface information for Sun Internet Administrator. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWisp/SUNWixamr

mcrm(1m)

Remove a service from the services list in Sun Internet Administrator, so that the service is no longer centrally managed. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin.

mcrmadm(1m)

Removes an authorized administrator from the system to deny access to all services registered with Sun Internet Administrator or to only deny the administrator access to specific services. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWixamc/sbin

mcunreg(1m)

Unregisters a service application to make it unavailable for management through Sun Internet Administrator. Removes the service's user interface information from Sun Internet Administrator. This command must be run on the machine where Sun Internet Administrator is installed and you require root access to run this command. This command is located in /opt/SUNWisp/SUNWixamr

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | DESCRIPTION | ATTRIBUTES | NOTES

mcadd(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

NAME

mcadd- Add a registered (mcreg) service to Sun^TM Internet Administrator^TM.

SYNOPSIS

mcadd -c componentID -v componentVersion -h host

DESCRIPTION

Adds the specified service to Sun Internet Administrator. Run mcreg before running mcadd and run mcadd on the machine where Sun Internet Administrator is installed. Root access is required to run this command.

OPTIONS

-c componentID

Specifies the service to be managed, by a service-unique identifier. The package name is recommended because it is guaranteed to be unique.

-h host

Specifies the host (by DNS name) where the service to be managed is installed.

-v componentVersion

Specifies the release version of the service to be managed. Recommended format is major.minor.

EXAMPLES

---

Example 1 Adding a Service




# /opt/SUNWixamc/sbin/mcadd -c SUNWftp -v 1.1 -h thurblig

This use of mcadd adds Sun^TM Internet FTP Server^TM version 1.1, installed on the machine thurblig, to Sun Internet Administrator.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcaddadm(1m), mcadmpwd(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m)

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

mcaddadm(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

NAME

mcaddadm- Add an administrator to Sun^TM Internet Administrator^TM authorized administrators list.

SYNOPSIS

mcaddadm {-n name} [-p password] -i componentID-version...

DESCRIPTION

Creates an administrator in Sun Internet Administrator with access to the version of services listed as the componentID-version option. To grant the administrator access to an additional service, run mcrmadm, then mcaddadm. Run mcaddadm on the machine where Sun Internet Administrator is installed. Root access is required to run this command.

OPTIONS

-i componentID-version

Specifies, by a service-specific identifier (package name) and version number of the service application, the Solaris ISP Server^TM service for the administrator to manage. Enter a -i option for each separate service required.

---

Note -

Run mchostls for a list of valid components that you can specify for the administrator to manage.

---

If this administrator will manage Sun Internet Administrator, enter SUNWixamc here. Do not list other packages, because access to Sun Internet Administratorauthorizes access to all services as well.

-n name

Specifies the name this administrator uses to log in to Sun Internet Administrator.

-p password

Specifies the password this administrator uses to log in to Sun Internet Administrator. Do not string this option with the command as password can be entered in non-printing mode. For security reasons, wait for the command to prompt for this password.

EXAMPLES

---

Example 1 Adding an Administrator to Two Services




# /opt/SUNWixamc/sbin/mcaddadm -n april -i SUNWixftp-1.1 -i SUNWixnsa-2.0 
# password: 

In the foregoing, the administrator april is created. The command prompts for her password to authorize her to manage both Sun^TM Internet FTP Server^TM 1.1, and Sun^TM Internet News Server^TM 2.0 and the entry is not echoed on the screen.

---

---

Example 2 Adding an Administrator of Sun Internet Administrator




# /opt/SUNWixamc/sbin/mcaddadm -n vickie -i SUNWixamc-1.1 
# password: 

In the foregoing, the administrator vickie is created. The utility prompts for her password to authorize her to manage Sun Internet Administrator 1.1 and the entry is not echoed on the screen. She can also administer any managed services.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcadd(1m), mcadmpwd(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m).

NOTES

If you enter the password option on the command line, it is visible to anyone who can see your screen and to anyone issuing a ps command while mcaddadm is running. You can omit the -p option on the command line, avoiding this risk. When the command prompts you for the password, your entry is not echoed on the screen.

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

mcadmpwd(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

NAME

mcadmpwd- Set the password for an administrator in Sun^TM Internet Administrator^TM.

SYNOPSIS

mcadmpwd -n name [-p password]

DESCRIPTION

Sets the password of an existing administrator. Run mcadmpwd on the machine where Sun Internet Administrator is installed. Root access is required to run this command.

OPTIONS

-n name

Specifies the administrator, by login name.

-p password

Specifies the new password for the administrator. Do not string this option with the command. For security reasons, wait for the command to prompt for the password.

EXAMPLES

---

Example 1 Setting an Administrator's Password




# /opt/SUNWixamc/sbin/mcadmpwd -n April
# password: 
# Re-enter password: 

In the foregoing example, the administrator April is prompted for her new password playground and the password is not echoed on the screen.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcadd(1m), mcaddadm(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m).

NOTES

If you enter the password option on the command line, it is visible to anyone who can see your screen and to anyone issuing a ps command while mcadmpwd is running. You can omit the -p options on the command line, avoiding this risk. The command then prompts you for this password, and your entry is not echoed on the screen.

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

mcdsclean(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | ENVIRONMENT VARIABLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

NAME

mcdsclean- Checks to see if registered services are still installed and if not found, deletes the service entries in the directory services.

SYNOPSIS

mcdsclean -a
mcdsclean hostname

DESCRIPTION

Checks the hosts registered with Sun Internet Administrator to see if services are still available for management. If services are not found, removes the service entries from the directory services.

This command gets executed every time you register a service for management from Sun Internet Administrator GUI. You must run this command on Sun Internet Administrator host to check a specific host or all hosts registered for management from Sun Internet Administrator. You need root access to run this command.

OPTIONS

-a

Indicates that all hosts must be checked for services still available for management from Sun Internet Administrator.

hostname

Specifies the host that must be checked for services still available for management from Sun Internet Administrator. When specifying host to check, specify the same host name you specified when registering the host.

EXAMPLES

---

Example 1 Check All Hosts




# /opt/SUNWixamc/sbin/mcdsclean -a

In the foregoing example, all hosts registered with Sun Internet Administrator are checked (using mchostls -h) to see if services are still available for management from Sun Internet Administrator. If any service is not found installed, the service entries are removed from the directory services.

---

---

Example 2 Check A Host




# /opt/SUNWixamc/sbin/mcdsclean tulip

In the foregoing example, host tulip is checked (using mchostls -h) to see if services on host tulip, registered with Sun Internet Administrator, are still installed and available for management from Sun Internet Administrator. If registered services are not found, the service entries are deleted from the directory services.

---

ENVIRONMENT VARIABLES

See environ(5) for descriptions of the following environment variables that affect the execution of command_name: NLSPATH.

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcadd(1m), mcaddadm(1m), mcadmpwd(1m), mcdsinit(1m)mchelp(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m)

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | ENVIRONMENT VARIABLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

mcdsinit(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

NAME

mcdsinit- Makes initial service entries in Sun^TM Directory Services

SYNOPSIS

mcdsinit -d DNofDSadmin [-w password] -n CconsoleAdmin [-p password] [-q]

DESCRIPTION

Makes initial service entries for Sun^TM Internet Administrator^TM in Sun Directory Services. If Sun Directory Services is available, the Sun Internet Administrator administrator name and password, provided (by you), binds with Sun Directory Services using the directory services administrator distinguished name and password, and makes the initial service entries.

If Sun Directory Services is not available when installing Sun Internet Administrator, run this command on the machine where Sun Internet Administrator is installed to make the initial entries in Sun Directory Services. Root access is required to run this command.

OPTIONS

-d DNofDSadmin

Specifies the distinguished name for binding to the Sun Directory Services as the directory services administrator.

h

Prints command usage message and exits.

-n ConsoleAdmin

Specifies the name of the administrator of Sun Internet Administrator used to make the initial entries in the directory services.

-p password

Indicates the password of the Sun Internet Administrator administrator used to make entries in the directory services. To ensure security for password, do not string this option with the command. Wait for the command to prompt you for the password.

-q

Suppresses output messages and the command is executed in a quiet mode. No error is reported.

-w password

Indicates the password of Sun Directory Services administrator used for binding to the directory services. To ensure security for passwords, do not string this option with the command. Wait for the command to prompt you for the password.

EXAMPLES

---

Example 1 Making Initial Entries




# /opt/SUNWixamc/sbin/mcdsinit -d cn=admin,o=sun,c=US -n april 
DA administrator password:  
IA administrator password: 

In the foregoing example,

• The directory services distinguished name and the Sun Internet Administrator administrator name are specified.

• The directory services and Sun Internet Administrator administrator passwords are omitted from the command line arguments. The utility prompts for these passwords and does not echo it on the command line, keeping the passwords secure.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcadd(1m), mcaddadm(1m), mcadmpwdd(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m)

NOTES

If you enter the password option on the command line, it is visible to anyone who can see your screen and to anyone issuing a ps command while mcdsinit is running. You can omit the -w and -p options on the command line, avoiding these risks. The command then prompts you for these passwords, and your entry is not echoed on the screen.

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

mchostls(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

NAME

mchostls- List all services on a given host.

SYNOPSIS

mchostls -h host

DESCRIPTION

Lists the package name and service name for each service installed and registered on the specified host. Use this utility to discover what services are available for management through Sun^TM Internet Administrator^TM. Run mchostls on the machine where Sun Internet Administrator is installed. Root access is required to run this command.

OPTIONS

-h host

Specifies the host whose installed services are to be displayed.

EXAMPLES

---

Example 1 mchostls Output




Invoke mchostls by entering it at the command line:

# /opt/SUNWixamc/sbin/mchostls -h thurblig

The following is displayed on your screen:

ID	Name
SUNWixnsa 1.1	Sun(TM) News
SUNWixadm 1.1	Sun(tm) FTP

The foregoing indicates that Sun Internet News Server and Sun Internet FTP Server are installed on thurblig and mcreg has been run for them, recording their management information.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcadd(1m), mcaddadm(1m), mcadmpwd(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mcreg(1m), mcrm(1m), mcrmadm(1m), mcunreg(1m)

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

mcrm(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

NAME

mcrm- Delete a service from Sun^TM Internet Administrator^TM.

SYNOPSIS

mcrm -c componentID -h host -v componentVersion

DESCRIPTION

Removes the specified service from Sun Internet Administrator, so that it is no longer centrally managed. Root access is required to run this command.

OPTIONS

-c componentID

Specifies, by a service-unique identifier (package name), the service to be removed.

-h host

Specifies the host where the service to be deleted is installed.

-v componentVersion

Specifies the release version of the service to be managed.

EXAMPLES

---

Example 1 Unmanaging a Service




# /opt/SUNWixamc/sbin/mcrm -c SUNWsamp -v 1.1 -h thurblig

In the foregoing, SUNWsamp version 1.1, installed on the machine thurblig, is deleted from Sun Internet Administrator. Even authorized administrators are no longer able to access the service's user interface through Sun Internet Administrator.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcIntro(1m)mcadd(1m), mcaddadm(1m), mcadmpwd(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrmadm(1m), mcunreg(1m)

NOTES

Run mcunreg after running mcrm to completely disable the component for administration from Sun Internet Administrator. Running mcrm alone leaves the service available for registering with Sun Internet Administrator for administration.

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO | NOTES

mcrmadm(1M)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO

NAME

mcrmadm- Delete an existing authorized administrator from Sun^TM Internet Administrator^TM

SYNOPSIS

mcrmadm -a| -i componentID-version -n name

DESCRIPTION

Deletes an existing administrator registered with Sun Internet Administrator. If -a is entered, completely deletes the administrator from the system. If -i is entered, deletes the service specified by componentID-version from the administrator's authorized services list. The administrator remains in the system, but can no longer access the specified service. Multiple services can be deleted from the administrator's authorized service list by repeating the -i option for each service to be deleted. Root access is required to run this command.

OPTIONS

-a

Specifies the removal of the administrator, deleting access to all services.

-i componentID-version

Specifies, by a service-specific identifier (package name) and version of service application, the service from which the administrator is removed.

-n name

Specifies the administrator to remove, by login name.

EXAMPLES

---

Example 1 Removing an administrator




# /opt/SUNWixamc/sbin/mcrmadm -a -n april

In the foregoing, april is removed from the system and cannot manage any services through Sun Internet Administrator.

# /opt/SUNWixamc/sbin/mcrmadm -i SUNWftp-1.1 -n april

In the foregoing, april no longer has access to Sun^TM Internet FTP Server^TM 1.1. She can still manage any other service for which she has authorization.

# /opt/SUNWixamc/sbin/mcrmadm -i SUNWftp-1.1 -i SUNWsns-1.1 -n april

In the foregoing, april no longer has access to Sun^TM Internet FTP Server^TM 1.1 and Sun^TM Internet News Server^TM 1.1. She can still manage any other service for which she has authorization.

---

EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWixamc
Interface Stability	Evolving

SEE ALSO

mcIntro(1m)mcadd(1m), mcaddadm(1m), mcadmpwd(1m), mcdsinit(1m), mcdsclean(1m), mchelp(1m), mchostls(1m), mcreg(1m), mcrm(1m), mcunreg(1m)

Sun Internet Administrator 1.1  Last Revised February 1999

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | EXIT STATUS | ATTRIBUTES | SEE ALSO