LIST-NET-DIRECTORIES

Display directories released for Net-Storage

Component:	BS2000
Functional area:	Net-Storage administration
Domain:	DEVICE STORAGE-MANAGEMENT
Privileges:	TSOS OPERATING
Routing code:	G

Function

The LIST-NET-DIRECTORIES command provides information on all directories of a net server which are released for use as Net-Storage. The listed directories or also the directories beneath them can be connected to BS2000 as Net-Storage (see the MOUNT-NET-STORAGE command).

Fundamental information on the use of Net-Storage in BS2000 is provided in the “Introduction to System Administration” [14 ]. How to work with files on Net-Storage is described in the "Introductory Guide to DMS" [13].

Format

LIST-NET-DIRECTORIES

SERVER = <composed-name 1..256 with-under> / <c-string 1..256 with-low> / *IP-ADDRESS(...)
	*IP-ADDRESS(...)
		|	IP-ADDRESS = <composed-name 7..15> / <c-string 2..39>
,CLIENT = <composed-name 1..8 with-under> / <c-string 1..8> / *DNS(...) / *IP-ADDRESS(...)
	*DNS(...)
		|	DNS-NAME = <c-string 1..256 with-low>
	*IP-ADDRESS(...)
		|	IP-ADDRESS = <composed-name 7..15> / <c-string 2..39>
,SELECT = *ALL / *MOUNTED / *NOT-MOUNTED

Operands

SERVER =
Determines the Net-Server whose released directories are to be listed.

SERVER = <composed-name 1..256 with-under> / <c-string 1..256 with-low>
Host name or fully qualified domain name of a net server.

SERVER = *IP-ADDRESS(...)
IP address of the net server.

IP-ADDRESS = <composed-name 7..15> / <c-string 2..39> 
Specifies the IP address of the net server in IPv4 or IPv6 format.

CLIENT = 
Specifies the Net-Client that is to be used to determine the released directories of the net server. The directories can be mounted via the net client, using the MOUNT-NET-STORAGE command.

CLIENT = <composed-name 1..8 with-under> / <c-string 1..8>
Internal BCAM name of the net client.

CLIENT = *DNS(...)
Domain name of the net client.

DNS-NAME = <c-string 1..256 with-low> 
Specifies the fully qualified domain name of the net client.

CLIENT = *IP-ADDRESS(...)
IP address of the net client.

IP-ADDRESS = <composed-name 7..15> / <c-string 2..39> 
Specifies the IP address of the net client in IPv4 or IPv6 format.

SELECT = *ALL / *MOUNTED / *NOT-MOUNTED 
Determines which of the released directories are displayed.

SELECT = *ALL
All directories are displayed which are released for the specified net client and are thus available for use as Net-Storage.

SELECT = *MOUNTED
All directories are displayed which are already mounted on the specified net client and connected to BS2000.

SELECT = *NOT-MOUNTED
All directories are displayed which have been released for the specified net client but have not yet been mounted and connected to BS2000.

Return codes

(SC2)	SC1	Maincode	Meaning/Guaranteed messages
	0	CMD0001	Command executed without error
	1	NKAN003	Syntax error in the input
	32	NKAN004	Error in command execution
	64	NKAN015	No relevant information available

Output format

Sample output

/list-net-directories server=*ip(172.17.65.103)),client=*ip(192.168.138.12)

-   NET-SERVER:  IPV4: 172.17.65.103 ——————————————————————————————————  (1)
-   NET-CLIENT:  IPV4: 192.168.138.12 —————————————————————————————————  (2)
************************************************************************
- NET-DIRECTORY: /nas/100/fgqa/SQ200/test    (MOUNT-ID = 1) ———————————  (3) 
************************************************************************
- NET-DIRECTORY: /nas/100/fgqa/HNC42    (MOUNT-ID = 2)
************************************************************************
- NET-DIRECTORY: /export/nas/100/fgqa    (NOT MOUNTED)
************************************************************************
- NET-DIRECTORY: /nas/100/fgqa    (NOT MOUNTED)
************************************************************************
- NET-DIRECTORY: /export    (NOT MOUNTED)
************************************************************************

(1)	NET-SERVER displays the name or IP address of the net server as specified in the command. For an IP address, the IPV4 or IPV6 format is also displayed.
(2)	NET-CLIENT displays the name or IP address of the net client as specified in the command. For an IP address, the IPV4 or IPV6 format is also displayed.
The following information is output in a separate information block for each released directory:
(3)	NET-DIRECTORY displays the path name of the released directory and the status. The status can assume the following values: (NOT MOUNTED) The directory is not connected. (MOUNT-ID = <n>) If the directory is connected, the mount ID is displayed.

Output in S variable

Output information	Name of the S variable	T	Contents	Condition
Directory name of the Net-Storage released on the net server	var(*LIST).DIR(*LIST).NAME	S	<name 1..64> ’’
Mount ID of the Net-Storage (0: volume not connected)	var(*LIST).DIR(*LIST).MOUNT-ID	I	<integer>
Name of the net server	var(*LIST).DIR(*LIST).SERVER.NAME1	S	<name 1..256> ’’
IP address of the net server in IPv4 format	var(*LIST).DIR(*LIST).SERVER.IPV41	S	<name 7..15> ’’
IP address of the net server in IPv6 format	var(*LIST).DIR(*LIST).SERVER.IPV61	S	<name 15..39> ’’
Name of the net client	var(*LIST).DIR(*LIST).CLIENT.NAME1	S	<name 1..256> ’’
DNS name of the net client	var(*LIST).DIR(*LIST).CLIENT.DNS1	S	<name 1..256> ’’
IP address of the net client in IPv4 format	var(*LIST).DIR(*LIST).CLIENT.IPV41	S	<name 7..15> ’’
IP address of the net client in IPv6 format	var(*LIST).DIR(*LIST).CLIENT.IPV61	S	<name 15..39> ’’

¹ Status-dependent output: empty string if the information is unavailable.