NAME

pmadm − port monitor administration

SYNOPSIS

pmadm −a [−p pmtag | −t type] −s svctag −i id −m pmspecific −v ver [−f xu]

[−y comment] [−z script]
pmadm −r −p pmtag −s svctag
pmadm −e −p pmtag −s svctag
pmadm −d −p pmtag −s svctag
pmadm −l [−t type | −p pmtag] [−s svctag]
pmadm −L [−t type | −p pmtag] [−s svctag]
pmadm −g −p pmtag −s svctag [−z script]
pmadm −g −s svctag −t type −z script

AVAILABILITY

SUNWcsu

DESCRIPTION

pmadm is the administrative command for the lower level of the Service Access Facility hierarchy, that is, for service administration.  A port may have only one service associated with it although the same service may be available through more than one port.  In order to uniquely identify an instance of a service, the pmadm command must identify both the port monitor or port monitors through which the service is available (−p or −t) and the service (−s).  See the option descriptions below. 

pmadm performs the following functions:

• add or remove a service

• enable or disable a service

• install or replace a per-service configuration script

• print requested service information

Any user on the system may invoke pmadm to request service status (−l or −L) or to print per-service configuration scripts (−g without the −z option).  pmadm with other options may be executed only by a privileged user. 

OPTIONS

−a Add a service.  pmadm adds an entry for the new service to the port monitor’s administrative file.  Because of the complexity of the options and arguments that follow the −a option, it may be convenient to use a command script or the menu system to add services. 

−d Disable a service.  Add x to the flag field in the entry for the service svctag in the port monitor’s administrative file.  This is the entry used by port monitor pmtag.  See the −f option, below, for a description of the flags available. 

−e Enable a service.  Remove x from the flag field in the entry for the service svctag in the port monitor administrative file.  This is the entry used by port monitor pmtag.  See the −f option, below, for a description of the flags available. 

−f xu The −f option specifies one or both of the following two flags which are then included in the flag field of the entry for the new service in the port monitor’s administrative file.  If the −f option is not included, no flags are set and the default conditions prevail.  By default, a new service is enabled and no utmp entry is created for it.  A −f option without a following argument is illegal. 

x   Do not enable the service svctag available through
    port monitor pmtag.  u   Create a utmp entry for service svctag available through
    port monitor pmtag. 

−g Print, install, or replace a per-service configuration script.  The −g option with a −p option and a −s option prints the per-service configuration script for service svctag available through port monitor pmtag.  The −g option with a −p option, a −s option, and a −z option installs the per-service configuration script contained in the file script as the per-service configuration script for service svctag available through port monitor pmtag.  The −g option with a −s option, a −t option, and a −z option installs the file script as the per-service configuration script for service svctag available through any port monitor of type type.  Other combinations of options with −g are invalid. 

−i id id is the identity that is to be assigned to service svctag when it is started.  id must be an entry in /etc/passwd. 

−l The −l option requests service information.  Used by itself and with the options described below it provides a filter for extracting information in several different groupings. 

−l By itself, the −l option lists all services on the system. 

−l −p pmtag
Lists all services available through port monitor pmtag. 

−l −s svctag
Lists all services with tag svctag. 

−l −p pmtag−ssvctag
Lists service svctag. 

−l −t type
Lists all services available through port monitors of type type. 

−l −t type−ssvctag
Lists all services with tag svctag available through a port monitor of type type. 

Other combinations of options with −l are invalid. 

−L The −L option is identical to the −l option except that output is printed in a condensed format. 

−m pmspecific
pmspecific is the port monitor-specific portion of the port monitor administrative file entry for the service. 

−p pmtag Specifies the tag associated with the port monitor through which a service (specified as −s svctag) is available. 

−r Remove a service.  When pmadm removes a service, the entry for the service is removed from the port monitor’s administrative file. 

−s svctag Specifies the service tag associated with a given service.  The service tag is assigned by the system administrator and is part of the entry for the service in the port monitor’s administrative file. 

−t type Specifies the the port monitor type. 

−v ver Specifies the version number of the port monitor administrative file.  The version number may be given as

−v ´pmspec −V`

where pmspec is the special administrative command for port monitor pmtag.  This special command is ttyadm for ttymon and nlsadmin for listen.  The version stamp of the port monitor is known by the command and is returned when pmspec is invoked with a −V option. 

−y comment
Associate comment with the service entry in the port monitor administrative file. 

−z script Used with the −g option to specify the name of the file that contains the per-service configuration script.  Modifying a configuration script is a three-step procedure.  First a copy of the existing script is made (−g alone).  Then the copy is edited.  Finally, the copy is put in place over the existing script (−g with −z). 

Options that request information write the requested information to the standard output.  A request for information using the −l option prints column headers and aligns the information under the appropriate headings.  In this format, a missing field is indicated by a hyphen.  A request for information in the condensed format using the −L option prints the information in colon-separated fields; missing fields are indicated by two successive colons.  # is the comment character. 

EXAMPLES

Add a service to a port monitor with tag pmtag.  Give the service the tag svctag.  Port monitor-specific information is generated by specpm.  The service defined by svctag will be invoked with identity root. 

pmadm −a −p pmtag −s svctag −i root −m `specpm −a arg1 −b arg2`

   −v `specpm −V`

Add a service with service tag svctag, identity guest, and port monitor-specific information generated by specpm to all port monitors of type type:

pmadm −a −s svctag −i guest −t type −m `specpm −a arg1 −b arg2`

   −v `specpm −V`

Remove the service svctag from port monitor pmtag:

pmadm −r −p pmtag −s svctag Enable the service svctag available through port monitor pmtag:

pmadm −e −p pmtag −s svctag Disable the service svctag available through port monitor pmtag:

pmadm −d −p pmtag −s svctag List status information for all services:

pmadm −l List status information for all services available through the port monitor with tag ports:

pmadm −l −p ports List the same information in condensed format:

pmadm −L −p ports List status information for all services available through port monitors of type listen:

pmadm −l −t listen Print the per-service configuration script associated with the service svctag available through port monitor pmtag:

pmadm −g −p pmtag −s svctag

EXIT CODES

If successful, pmadm will exit with a status of 0.  If it fails for any reason, it will exit with a non-zero status. 

FILES

/etc/saf/pmtag/_config
/etc/saf/pmtag/svctag
/var/saf/pmtag/∗

SEE ALSO

sac(1M), sacadm(1M), doconfig(3N)

SunOS 5.5  —  Last change: 14 Sep 1992