Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
pmadm(1M)							     pmadm(1M)

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

       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 iden-
       tify 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 .

       pmadm performs the following functions:

	 o  adds or removes a service

	 o  enables or disables	a service

	 o  installs or	replaces a per-service configuration script

	 o  prints 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.

       The following options are supported:

       -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  adminis-
		       trative	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	admin-
		       istrative  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 ad-
		       ministrative 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	utmpx entry is
		       created	for it.	An -f option without a following argu-
		       ment is illegal.

		       x	Do not enable  the  service  svctag  available
				through	port monitor pmtag.

		       u	Create a utmpx entry for service svctag	avail-
				able 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 op-
		       tion with a -p option, a	-s option, and a -z option in-
		       stalls  the  per-service	configuration script contained
		       in the file script  as  the  per-service	 configuration
		       script  for service svctag available through port moni-
		       tor pmtag. The -g option	with a - s option,  a  -t  op-
		       tion,  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 it-
		       self  and with the options described below, it provides
		       a filter	for extracting information in several  differ-
		       ent 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 en-
		       try  for	the service is removed from the	port monitor's
		       administrative file.

       -s svctag       Specifies the service tag associated with a given  ser-
		       vice.  The service tag is assigned by the system	admin-
		       istrator	and is part of the entry for  the  service  in
		       the port	monitor's administrative file.

       -t type	       Specifies the port monitor type.

       -v ver	       Specifies the version number of the port	monitor	admin-
		       istrative 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 re-
		       turned 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	proce-
		       dure. 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	 head-
       ings.  In  this format, a missing field is indicated by a hyphen. A re-
       quest 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.

       Example 1: Adding a Service to a	Port Monitor with the Tag pmtag

       The following command adds a service to a port monitor with  tag	 pmtag
       and  gives the service the tag svctag. The port monitor-specific	infor-
       mation 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`

       Example 2: Adding a Service with	Service	Tab svctag

       The  following command adds 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`

       Example 3: Removing a Service

       The  following command removes the service svctag from port monitor pm-
       tag:

       pmadm -r	-p pmtag -s svctag

       Example 4: Enabling a Service

       The following command enables the service svctag	available through port
       monitor pmtag:

       pmadm -e	-p pmtag -s svctag

       Example 5: Disabling a Service

       The  following  command	disables  the service svctag available through
       port monitor pmtag:

       pmadm -d	-p pmtag -s svctag

       Example 6: Listing Status Information

       The following command lists status information for all services:

       pmadm -l

       Example 7: Listing Status Information

       The following command lists status information for all services	avail-
       able through the	port monitor with tag ports:

       pmadm -l	-p ports

       Example 8: Listing Status Information in	Condensed Format

       The  following  command	lists  the status information for all services
       available through the port monitor with tag ports in condensed format:

       pmadm -L	-p ports

       Example 9: Listing Status Information for All Services

       List status information for all services	available through  port	 moni-
       tors of type listen:

       pmadm -l	-t listen

       Example 10: Printing the	per-service Configuration

       The following command prints the	per-service configuration script asso-
       ciated with the service svctag available	through	port monitor pmtag:

       pmadm -g	-p pmtag -s svctag

       The following exit values are returned:

       0	Successful operation.

       >0	Operation failed.

       /etc/saf/pmtag/_config

       /etc/saf/pmtag/svctag

       /var/saf/pmtag/*

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsu			   |
       +-----------------------------+-----------------------------+

       sac(1M),	sacadm(1M), doconfig(3NSL), attributes(5)

				  10 Nov 1998			     pmadm(1M)

NAME | SYNOPSIS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pmadm&sektion=1m&manpath=SunOS+5.10>

home | help