SHOW-NSM-CONFIGURATION Show information on state of NSM and its partners

Description status: Functional area: Domain: Privileges:	NSM V21.0A Pubset and MRSCAT management MULTI-CATALOG-AND-PUBSET-MGMT TSOS OPERATING SW-MONITOR-ADMINISTRATION
Routing code:	@

Function

The SHOW-NSM-CONFIGURATION command provides information on the state of the NSN subsystem and on the partners in an XCS network. The information is issued from the viewpoint of the local system.

The command supports structured output in S variables.

Format

SHOW-NSM-CONFIGURATION

INFORMATION = *SUMMARY / *ALL / *HOSTS(...)
	*HOSTS(...)
		|	SELECT = *ALL / <alphanum-name 1..8>
,OUTPUT = *SYSOUT / *SYSLST(...)
	*SYSLST(...)
		|	SYSLST-NUMBER = *STD / <integer 1..99>

Operands

INFORMATION = *SUMMARY / *ALL / *HOSTS(...)
Specifies the information that the user wishes to view.

INFORMATION = *SUMMARY
Default: a summary of the local NSM settings and the state of the connection system is output.

INFORMATION = *ALL
All information on the NSM subsystem in the current XCS network of the own system is output. This information comprises:

• the local NSM configuration parameters

• the connection and network data of all systems in the current XCS network.

INFORMATION = *HOSTS(...)
The connection and network data of the systems specified with the SELECT operand is output.

SELECT = *ALL / <alphanum-name 1..8>
Specifies for which systems information is output.

SELECT = *ALL
Information is issued for all systems to which there is an NSM network relationship.

SELECT = <alphanum-name 1..8>
Information is issued for the specified system.

OUTPUT = *SYSOUT / SYSLST(...)
Defines the destination to which output is directed.

OUTPUT = *SYSOUT
Default: output is directed to the SYSOUT system file.

OUTPUT = SYSLST(...)
Output is directed to the SYSLST system file.

SYSLST-NUMBER = *STD / <integer 1..99>
Specifies whether output is to be directed to the SYSLST system file or to one of the SYSLST files from SYSLST01 to SYSLST99.

SYSLST-NUMBER = *STD
Default: output is to be directed to the SYSLST system file.

SYSLST-NUMBER = <integer 1..99>
Output is to be directed to one of the SYSLST files from SYSLST01 to SYSLST99.

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	No error
	0	NLX1020	No information for current selection
	3	CMD2203	Wrong syntax file
	32	CMD0221	System error (internal error)
	32	CMD2009	Error during output to a structured S variable
	32	NLX1019	Error while processing the command
	64	CMD0216	User does not have the necessary privileges
	130	NLX1019	Error while processing the command; repeat possible later

Output format

The contents of the output depends on the selection made:

Output for INFORMATION=*SUMMARY

/SHOW-NSM-CONFIGURATION INFORMATION=*SUMMARY
SHOW-NSM-CONFIGURATION                       DATE: yyyy-mm-dd, TIME: hh:mm:ss
-----------------------------------------------------------------------------
SUMMARY
 OWN HOST NAME = D017ZE30         XCS NAME = XCS
 NSM VERSION =    V21.0A
 COMM = *BY-MSCF                  COMM-STATE = *MSCF-ACTIVE
 COMM-TYPE = *TOKEN-RING
 MINIMUM TOKEN-DELAY TIME =  15  MAXIMUM TOKEN-DELAY TIME =  100
-----------------------------------------------------------------------------
SHOW-NSM-CONFIGURATION                                         END OF DISPLAY

Output for INFORMATION=*HOSTS(*ALL)

/SHOW-NSM-CONFIGURATION INFORMATION=*HOSTS(*ALL)
SHOW-NSM-CONFIGURATION                       DATE: yyyy-mm-dd, TIME: hh:mm:ss
-----------------------------------------------------------------------------
HOSTS
NUM OF HOSTS = 2
 HOST NAME   COMM STATE   SYS VERSION  NSM VERSION
-----------------------------------------------------------------------------
 D016ZE01    MSCF ACTIVE  V21.0A       V21.0A
 D016ZE02    LOCAL HOST   V21.0A       V21.0A
-----------------------------------------------------------------------------
SHOW-NSM-CONFIGURATION                                         END OF DISPLAY

Key to output

The output fields and their possible values are listed in alphabetical order in the table below. Note that each output field may also contains the keyword UNDEFINED (UNDEFINED: no information available) which we have not expressly included in the table.

Output field	Keyword / meaning
COMM STATE	System status with regard to the connection: *NONE: the NSM subsystem is still in the installation phase or the local system is the only system in the network. *LOCAL-HOST: local system *MSCF-ACTIVE: NSM only uses the MSCF connection as a communication path *INTERRUPTED: the connection to the partner is currently interrupted
COMM TYPE	Communication method: *TOKEN-RING NSM uses the token ring communication method.
COMMUNICATION	Communication path: *BY-MSCF: NSM uses MSCF
HOST NAME	Host name of the partner (as issued by the SHOW-MSCF-CONFIGURATION command)
MAXIMUM TOKEN DELAY TIME	Time (1..32767 ms) which an idle token requires to complete one cycle.
MINIMUM TOKEN DELAY TIME	Time (0..32767 ms) which a token requires to complete one cycle in normal operation.
NSM VERSION	NSM version running on the host or on the partner. V21.0A: BS2000 OS DX V1.0 *UNDEFINED: version unknown
NUMBER OF HOSTS	Number of hosts (1..16) on which information is issued.
OWN HOST NAME	Name of own (local) host.
SYS VERSION	BS2000-Version running on the host/partner. V21.0A: BS2000 OS DX V1.0
XCS NAME	Name of the XCS network: <nnnnnnnn>: alphanumeric, 1..8 characters UNDEFINED: no information available.

Output in S variables

The INFORMATION operand of the command determines which S variables are to be created. INFORMATION accepts the following values:

Notation used in command	Abbreviated form used in table
INFORMATION = *SUMMARY INFORMATION = *HOSTS INFORMATION = *ALL	1 2 3

Output information	Name of the S variable	T	Contents	Condition
Number of hosts about which information is provided	var(*LIST).ALL.HOSTS.NUM-OF-HOSTS	I	<integer 1.. 16>	3
Unique name of the local host / partner	var(*LIST).ALL.HOSTS.HOST(*LIST). HOST-NAME	S	<c-string 1 .. 8> UNDEFINED	3
Status of hosts in respect of the connection	var(*LIST).ALL.HOSTS.HOST(*LIST). COMM-STATE	S	*NONE *LOCAL-HOST *MSCF-ACTIVE *INTERRUPTED	3
BS2000 version running on the local host/partner	var(*LIST).ALL.HOSTS.HOST(*LIST). SYS-VERSION	S	<c-string 1 .. 6> UNDEFINED	3
NSM version running on the local host/partner	var(*LIST).ALL.HOSTS.HOST(*LIST). NSM-VERSION	S	<c-string 1 .. 6> UNDEFINED	3
Communication path	var(*LIST).ALL.SUMMARY.COMM	S	*BY-MSCF	3
Communication method	var(*LIST).ALL.SUMMARY.COMM-TYPE	S	*TOKEN-RING	3
Status of hosts in respect of the connection	var(*LIST).ALL.SUMMARY.COMM-STATE	S	*NONE *LOCAL-HOST *MSCF-ACTIVE *INTERRUPTED	3
Unique name of the local host	var(*LIST).ALL.SUMMARY.HOST-NAME	S	<c-string 1 .. 8>	3
Specified minimum time required for a token to complete a circulation in the no-load state.	var(*LIST).ALL.SUMMARY. MAX-DELAY-TIME	I	<integer 1 .. 32767>	3
Specified minimum time required for a token to complete a circulation in normal operation.	var(*LIST).ALL.SUMMARY.MIN-DELAY-TIME	I	<integer 0 .. 32767>	3
NSM version running on the local processor V19.0A: BS2000/OSD-BC V10.0 V20.0A: BS2000/OSD-BC V11.0 V21.0A: BS2000 OS DX V1.0	var(*LIST).ALL.SUMMARY.NSM-VERSION	S	V19.0A V20.0A V21.0A	3
Unique name of the XCS network	var(*LIST).ALL.SUMMARY.XCS-NAME	S	<c-string 1 .. 8> UNDEFINED	3
Number of hosts about which information is provided	var(*LIST).HOSTS.NUM-OF-HOSTS	I	<integer 1 .. 16>	2
Unique name of the local host/ partner	var(*LIST).HOSTS.HOST(*LIST). HOST-NAME	S	<c-string 1 .. 8> UNDEFINED	2
Status of hosts in respect of the connection	var(*LIST).HOSTS.HOST(*LIST). COMM-STATE	S	*NONE *LOCAL-HOST *MSCF-ACTIVE *INTERRUPTED	2
BS2000 version running on the local host	var(*LIST).HOSTS.HOST(*LIST). SYS-VERSION	S	<c-string 1 .. 6> UNDEFINED	2
NSM version running on the local host	var(*LIST).HOSTS.HOST(*LIST). NSM-VERSION	S	<c-string 1 .. 6> UNDEFINED	2
Communication path	var(*LIST).SUMMARY.COMM	S	*BY-MSCF	1
Communication method	var(*LIST).SUMMARY.COMM-TYPE	S	*TOKEN-RING	1
Status of hosts in respect of the connection	var(*LIST).SUMMARY.COMM-STATE	S	*NONE *LOCAL-HOST *MSCF-ACTIVE *INTERRUPTED	1
NSM version running on the local processor V19.0A: BS2000/OSD-BC V10.0 V20.0A: BS2000/OSD-BC V11.0 V21.0A: BS2000 OS DX V1.0	var(*LIST).SUMMARY.NSM-VERSION	S	V19.0A V20.0A V21.0A	1
Specified minimum time required for a token to complete a circulation in the no-load state.	var(*LIST).SUMMARY.MAX-DELAY-TIME	I	<integer 1 .. 32767>	1
Specified minimum time required for a token to complete a circulation in normal operation.	var(*LIST).SUMMARY.MIN-DELAY-TIME	I	<integer 0 .. 32767>	1
Unique name of the local host	var(*LIST).SUMMARY.HOST-NAME	S	<c-string 1 .. 8>	1
Unique name of the XCS network	var(*LIST).SUMMARY.XCS-NAME	S	<c-string 1 .. 8> UNDEFINED	1

Examples

/declare-variable var-name=var(type=*structure),multiple-elem=*list

/exec-cmd (show-nsm-configuration inf=*summary),text-output=*none, structure-output=var

/show-var var
VAR(*LIST).SUMMARY.HOST-NAME = LOLITA2

VAR(*LIST).SUMMARY.XCS-NAME = OS36XCS

VAR(*LIST).SUMMARY.NSM-VERSION = V21.0A

VAR(*LIST).SUMMARY.COMM-TYPE = *TOKEN-RING

VAR(*LIST).SUMMARY.MIN-DELAY-TIME = 15

VAR(*LIST).SUMMARY.MAX-DELAY-TIME = 100

VAR(*LIST).SUMMARY.COMM = *BY-MSCF

VAR(*LIST).SUMMARY.COMM-STATE = *MSCF-ACTIVE

/exec-cmd (show-nsm-configuration inf=*host),text-output=*none, structure-output=var
/show-var var
VAR(*LIST).HOSTS.NUM-OF-HOSTS = 2

VAR(*LIST).HOSTS.HOST(*LIST).HOST-NAME = STARTA2

VAR(*LIST).HOSTS.HOST(*LIST).COMM-STATE = *MSCF-ACTIVE

VAR(*LIST).HOSTS.HOST(*LIST).SYS-VERSION = V21.0A

VAR(*LIST).HOSTS.HOST(*LIST).NSM-VERSION = V21.0A

VAR(*LIST).HOSTS.HOST(*LIST).HOST-NAME = LOLITA2

VAR(*LIST).HOSTS.HOST(*LIST).COMM-STATE = *LOCAL-HOST

VAR(*LIST).HOSTS.HOST(*LIST).SYS-VERSION = V21.0A

VAR(*LIST).HOSTS.HOST(*LIST).NSM-VERSION = V21.0A

/exec-cmd (show-nsm-configuration inf=*all),text-output=*none, structure-output=var
/show-var var
VAR(*LIST).ALL.SUMMARY.HOST-NAME = LOLITA2

VAR(*LIST).ALL.SUMMARY.XCS-NAME = OS36XCS

VAR(*LIST).ALL.SUMMARY.NSM-VERSION = V21.0A

VAR(*LIST).ALL.COMM-TYPE = *TOKEN-RING

VAR(*LIST).ALL.SUMMARY.MIN-DELAY-TIME = 15

VAR(*LIST).ALL.SUMMARY.MAX-DELAY-TIME = 100

VAR(*LIST).ALL.SUMMARY.COMM = *BY-MSCF

VAR(*LIST).ALL.SUMMARY.COMM-STATE = *MSCF-ACTIVE

VAR(*LIST).ALL.HOSTS.NUM-OF-HOSTS = 2

VAR(*LIST).ALL.HOSTS.HOST(*LIST).HOST-NAME = STARTA2

VAR(*LIST).ALL.HOSTS.HOST(*LIST).COMM-STATE = *MSCF-ACTIVE

VAR(*LIST).ALL.HOSTS.HOST(*LIST).SYS-VERSION = V21.0A

VAR(*LIST).ALL.HOSTS.HOST(*LIST).NSM-VERSION = V21.0A

VAR(*LIST).ALL.HOSTS.HOST(*LIST).HOST-NAME = LOLITA2

VAR(*LIST).ALL.HOSTS.HOST(*LIST).COMM-STATE = *LOCAL-HOST

VAR(*LIST).ALL.HOSTS.HOST(*LIST).SYS-VERSION = V21.0A

VAR(*LIST).ALL.HOSTS.HOST(*LIST).NSM-VERSION = V21.0A