Statistical NCPs

v2.x	v3.x	v4.x	v5.x
			•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(17)		byte
	 10	SearchNumber	(variable)	long (Lo-Hi)

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion  	byte
	 13	VConsoleRevision 	byte
	 14	serverInfoFlags         word (Lo-Hi)
	 16	serverGUID 		byte[16]
	 32	nextSearchNumber	long (Lo-Hi)
	 36	addressesReturned	long (Lo-Hi)
	 40+	ncpNetWorkAddress	structure's

Completion Code

	0	0x00	Successful
	119	0x77	Insufficent Buffer Size
	126	0x7E	Invalid Length

Remarks

This NCP enumerates and returns the network address structures that the server is currently accepting NCP requests on.

The following request parameters are defined:

The SearchNumber field is used to restart multiple replys if necessary to retrieve all network address structures. This field is initially set to zero.

The following return parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

CLUSTER_MEMBER_BIT 0x00000001 is defined for the serverInfoFlags parameter.

The server's GUID is automatically generated by the OS the first time the server is brought up, once a LAN board is loaded (the Ethernet address of a LAN board is part of the GUID). The server GUID will be all zeros until a LAN board is loaded the first time. The server GUID is kept in the registry so the initial GUID created for the server will be preserved across reboots unless the registry is corrupted or deleted. In this case, the startup code will automatically generate a new server GUID as if this was the first boot.

The nextSearchNumber field will contain a non-zero value if unable to return all network address structures in the reply packet. If the field is zero, then all network address structures have been returned in the reply packet.

The addressesReturned field is used to indicate the number of ncpNetWorkAddress structures returned by the server.

The ncpNetWorkAddress is a list of ncpNetWorkAddress structures, and the definition follows:

		struct ncpNetWorkAddress
		{
			long addressType;
			long addressSize;
			byte address[addressSize];
		};

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content			Type
	(request header)
	  6	FunctionCode	(123)	byte
	  7	SubFuncStrucLen	(1)	word (Hi-Lo)
	  9	SubFuncCode	(07)	byte

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion		byte
	 13	VConsoleRevision	byte
	 14	reserved		word (Lo-Hi)
	 16	FailedAllocReqCnt	long (Lo-Hi)
	 20	NumberOfAllocs		long (Lo-Hi)
	 24	NoMoreMemAvlCnt		long (Lo-Hi)
	 28	NumOfGarbageColl	long (Lo-Hi)
	 32	FoundSomeMem	 	long (Lo-Hi)
	 36	NumOfChecks		long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about garbage collection on a server. The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The failedAllocReqCount parameter contains the number of times memory allocation failed since the server was brought up.

The numberOfAllocs parameter contains the number of memory allocations made since the server was brought up.

The noMoreMemAvlCnt parameter contains the number of times that allocation failed because there was no memory available since the server was brought up.

The numOfGarbageColl parameter contains the number of times garbage collection was invoked since the server was brought up.

The foundSomeMem parameter contains the number of times garbage collection reclaimed memory.

The numOfChecks parameter contains the number of times garbage collection checked for memory since the server was brought up.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content			Type
	(request header)
	  6	FunctionCode	(123)	byte
	  7	SubFuncStrucLen	(9)	word (Hi-Lo)
	  9	SubFuncCode	(14)	byte
	 10	StartConnNumber		long (Lo-Hi)
	 14	ConnectionType		long (Lo-Hi)

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion		byte
	 13	VConsoleRevision	byte
	 14	reserved		word (Lo-Hi)
	 16	ActiveConnBitList	byte[512]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	253	0xFD	Invalid Connection
	255	0xFF	Failure or Invalid Start Number

Remarks

This NCP returns a connection list of all connections of a given type on the currently connected server. The following request format parameters are defined:

The StartConnNumber parameter is the starting connection number from which to begin the list.

The ConnectionType parameter can have one of the following values:

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The ActiveConnBitList parameter indicates active connections. An array of 512 bytes is returned where a bit is set for each active connection. The connection number is determined by its position in the array.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content			Type
	(request header)
	 6	FunctionCode	(123)	byte
	 7	SubFuncStrucLen	(1)	word (Hi-Lo)
	 9	SubFuncCode	(01)	byte
	10	VersionNumber	(01)	byte
	11	RevisionNumber	(00)	byte

ReplyFormat

	Offset	Content			Type
	(reply header)
	 8	CurrentServerTime	long (Lo-Hi)
	12	VConsoleVersion		byte
	13	VConsoleRevision	byte
	14	reserved		word (Lo-Hi)
	16	Counters		structure
	16+[Counters]	ExtraCacheCntrs structure
	16+[Counters
		+ExtraCacheCntrs] MemoryCounters structure	
	16+[Counters
		+ExtraCacheCntrs
		+MemoryCounters] TrendCounters structure
	16+[Counters
		+ExtraCacheCntrs
		+MemoryCounters
		+TrendCounters] CacheInfo structure

Counters Structure

	Offset	Content					Type
	 0	ReadExistingBlockCount			long (Lo-Hi)
	 4	ReadExistingWriteWaitCount		long (Lo-Hi)
	 8	ReadExistingPartialReadCount		long (Lo-Hi)
	12	ReadExistingReadErrorCount		long (Lo-Hi)
	16	WriteBlockCount				long (Lo-Hi)
	20	WriteEntireBlockCount			long (Lo-Hi)
	24	InternalDiskGetCount			long (Lo-Hi)
	28	InternalDiskGetNeedToAllocateCount	long (Lo-Hi)
	32	InternalDiskGetSomeoneBeatMeCount	long (Lo-Hi)
	36	InternalDiskGetPartialReadCount		long (Lo-Hi)
	40	InternalDiskGetReadErrorCount		long (Lo-Hi)
	44	AsyncInternalDiskGetCount		long (Lo-Hi)
	48	ASyncInternalDiskGetNeedToAlloc		long (Lo-Hi)
	52	ASyncInternalDiskGetSomeoneBeatMe 	long (Lo-Hi)
	56	ErrorDoingASyncReadCount		long (Lo-Hi)
	60	InternalDiskGetNoReadCount		long (Lo-Hi)
	64	InternalDiskGetNoReadAllocateCount 	long (Lo-Hi)
	68	InternalDiskGetNoReadSomeoneBeatMeCount	long (Lo-Hi)
	72	InternalDiskWriteCount			long (Lo-Hi)
	76	InternalDiskWriteAllocateCount		long (Lo-Hi)
	80	InternalDiskWriteSomeoneBeatMeCount 	long (Lo-Hi)
	84	WriteErrorCount				long (Lo-Hi)
	88	WaitOnSemaphoreCount			long (Lo-Hi)
	92	AllocateBlockIHadToWaitForSomeoneCount	long (Lo-Hi)
	96	AllocateBlockCount			long (Lo-Hi)
	100	AllocateBlockIHadToWaitCount		long (Lo-Hi)

Extra Cache Counters Structure

	Offset	Content					Type
	 0	InternalDiskGetNoWaitCount		long (Lo-Hi)
	 4	InternalDiskGetNoWaitNeedToAllocateCount long (Lo-Hi)
	 8	InternalDiskGetNoWaitNoBlockCount	long (Lo-Hi)
	12	IDGetNoReadNoWaitCount			long (Lo-Hi)
	16	IDGetNoReadNoWaitSemaphoredCount	long (Lo-Hi)
	20	IDGetNoReadNoWaitNoBufferCount		long (Lo-Hi)
	24	IDGetNoReadNoWaitAllocateCount		long (Lo-Hi)
	28	IDGetNoReadNoWaitNoAllocCount		long (Lo-Hi)
	32	IDGetNoReadNoWaitNoAllocSemaphoredCount	long (Lo-Hi)
	36	IDGetNoReadNoWaitNoAllocAllocateCount	long (Lo-Hi)

(Cache) Memory Counters Structure

	Offset	Content				Type
	 0	OriginalNumberOfCacheBuffers	long (Lo-Hi)
	 4	CurrentNumberOfCacheBuffers	long (Lo-Hi)
	 8	CacheDirtyBlockThreshold	long (Lo-Hi)
	12	WaitNodeCount			long (Lo-Hi)
	16	WaitNodeAllocFailureCount	long (Lo-Hi)
	20	MoveCacheNodeCount		long (Lo-Hi)
	24	MoveCacheNodeFromAvailCount	long (Lo-Hi)
	28	AccelerateCacheNodeWriteCount	long (Lo-Hi)
	32	RemoveCacheNodeCount		long (Lo-Hi)
	36	RemoveCacheNodeFromAvailCount	long (Lo-Hi)

(Cache) Trend Counters Structure

	Offset	Content				Type
	 0	NumOfCacheChecks		long (Lo-Hi)
	 4	NumOfCacheHits			long (Lo-Hi)
	 8	NumOfDirtyCacheChecks		long (Lo-Hi)
	12	NumOfCacheDirtyHits		long (Lo-Hi)
	16	CacheUsedWhileChecking		long (Lo-Hi)
	20	WaitTillDirtyBlocksDecreaseCnt	long (Lo-Hi)
	24	AllocateBlockFromAvailCount	long (Lo-Hi)
	28	AllocateBlockFromLRUCount	long (Lo-Hi)
	32	AllocateBlockAlreadyWaiting	long (Lo-Hi)
	36	LRUSittingTime			long (Lo-Hi)
	40	NumOfCacheCheckNoWait		long (Lo-Hi)
	44	NumOfCacheHitsNoWait		long (Lo-Hi)

Cache Info Structure

	Offset	Content				Type
	  0	MaximumByteCount		long (Lo-Hi)
	  4	MinimumNumberOfCacheBuffers	long (Lo-Hi)
	  8	MinimumCacheReportThreshold	long (Lo-Hi)
	 12	AllocateWaitingCount		long (Lo-Hi)
	 16	NDirtyBlocks			long (Lo-Hi)
	 20	CacheDirtyWaitTime		long (Lo-Hi)
	 24	CacheMaximumConcurrentWrites	long (Lo-Hi)
	 28	MaximumDirtyTime		long (Lo-Hi)
	 32	NumberOfDirectoryCacheBuffers	long (Lo-Hi)
	 36	CacheByteToBlockShiftFactor	long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

The SubFuncStrucLen and VersionNumber fields are important to understand before issuing this NCP. If the SubFuncStrucLen is passed in as 1, then the reply buffer will contain the following structures:
CacheCounters
MemoryCounters
TrendCounters
CacheInfo
The TrendCounters structure also WILL NOT contain the last 2 longs (NumOfCacheCheckNoWait, NumOfCacheHitsNoWait) shown in the structure definition above. The last field in the TrendCounters structure will be LRUSittingTime.
If the SubFuncStrucLen is passed in as 3 and the version is set to 1, then you get back all of the cache counters just mentioned as well as some additional information as follows:
CacheCounters
ExtraCacheCounters
MemoryCounters
TrendCounters
CacheInfo
The additional info is the ExtraCacheCounters structure and the addition of the last 2 longs (NumOfCacheCheckNoWait, NumOfCacheHitsNoWait) in the TrendCounters structure.
You will need to adjust your reply buffer for this additional info if you specify a SubFuncStrucLen of 3 and version of 1 in the request.

This NCP returns cache buffer information for the current connection.

The following request format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When the value in this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The CacheCntrs parameter contains an array of counters that are used by Novell for debugging.

The Counters, TrendCntrs, and CacheInfo parameters contain structures which hold cache buffer information:

Cache Memory Counters structure:

The OriginalNumberOfCacheBuffers field contains the number of cache buffers that existed when the server was brought up.

The CurrentNumberOfCacheBuffers field contains the number of cache buffers presently on the server.

The CacheDirtyBlockThreshold field contains the maximum number of cache blocks allowed to be dirty simultaneously.

The debugCounters field contains an array of counters that are used by Novell for debugging.

Cache Trend Counters structure:

The NumOfCacheChecks field contains the total number of times any block in the cache was looked at since the server was brought up.

The NumOfCacheHits field contains the number of times cache requests were serviced from existing cache blocks.

The debugCounters field contains an array of counters that are used by Novell for debugging.

The LRUSittingTime field contains the time in ticks that the oldest cache block has been available (sitting in the LRU list).

Cache Information structure:

The MaximumByteCount field contains the maximum length (in bytes) of a cache block.

The MinimumNumberOfCacheBuffers field contains the minimum number of cache buffers allowed on the server. This number can be set using the SET console command. Supported values are 20 to 1000; the default value is 20.

The MinimumCacheReportThreshold field contains the number of cache buffers used for the report threshold. When the cache buffers reach a number equal to the minimum number of cache buffers plus this report threshold, the server sends a message warning that cache buffers are getting low. This number can be set using the SET console command. Supported values are 0 to 1000; the default value is 20.

The AllocateWaitingCount field contains the number of processes waiting to allocate a cache block.

The NDirtyBlocks field contains the number of dirty blocks waiting to write to disk.

The CacheDirtyWaitTime field contains the maximum wait before a write request is written to disk. This value can be set using the SET console command. Supported values are 0.1 seconds to 10 seconds; the default value is 3.3 seconds.

The CacheMaximumConcurrentWrites field contains the maximum number of write requests for changed file data that can be put in the elevator before the disk head begins a sweep across the disk. This value can be set using the SET console command. Supported values are 10 to 100; the default value is 50.

The MaximumDirtyTime field contains the longest time (in ticks) that a dirty block has waited before it was written to disk since the server was brought up.

The NumberOfDirectoryCacheBuffers field contains the number of directory cache buffers on the server.

The CacheByteToBlockShiftFactor field contains the factor used to determine the block size. Block size is calculated by the following equation, where n is the shift factor: block size = 2n+9 bytes

v2.x	v3.x	v4.x	v5.x
		•	•

Request

	Offset	Content			Type
	(request header)
	6	FunctionCode	(123)	byte
	7	SubFuncStrucLen	(5)	word (Hi-Lo)
	9	SubFunctionCode	(72)	byte
	10	VolumeNumber		long (Lo-Hi)

Reply

	Offset	Content			Type
	(reply header)
	8	CmpHiTickHigh		long (Lo-Hi)
	12	CmpHiTickCnt 		long (Lo-Hi)
	16	CmpByteInCount		long (Lo-Hi)
	20	CmpByteOutCnt 		long (Lo-Hi)
	24	CmpHiByteInCnt		long (Lo-Hi)
	28	CmpHiByteOutCnt		long (Lo-Hi)
	32	DeCpHiTickHigh		long (Lo-Hi)
	36	DeCpHiTickCnt		long (Lo-Hi)
	40	DeCpByteInCount 	long (Lo-Hi)
	44	DeCpByteOutCnt	 	long (Lo-Hi)
	48	DeCpHiByteInCnt 	long (Lo-Hi)
	52	DeCpHiByteOutCnt	long (Lo-Hi)

Completion Code

	0	0x00	Successful

Remarks

This NCP returns current times & counts on a selected Volume.

v2.x	v3.x	v4.x	v5.x
		•	•

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(123)		byte
	7	SubFuncStrucLen	(5)		word (Hi-Lo)
	9	SubFunctionCode	(70)		byte
	10	VolumeNumber			long (Lo-Hi)

Reply

	Offset	Content				Type
	(reply header)
	8	ParentDirEntry			long (Lo-Hi)
	12	DirectoryEntry			long (Lo-Hi)
	16	compressionStage		long (Lo-Hi)
	20	ttlIntermediateBlks		long (Lo-Hi)
	24	ttlCompBlks			long (Lo-Hi)
	28	ttlInitialBlks			long (Lo-Hi)
	32	curIntermediateBlks		long (Lo-Hi)
	36	curCompBlks			long (Lo-Hi)
	40	curInitialBlks			long (Lo-Hi)
	44	fileFlags			long (Lo-Hi)
	48	projectedCompSize		long (Lo-Hi)
	52	originalSize			long (Lo-Hi)
	56	compressVolume			long (Lo-Hi)
	60	DOSFileNameLen			byte
	61	DOSFileName			byte

Completion Code

	0	0x00	Successful

Remarks

This NCP returns the file currently being compressed on a selected volume.

v2.x	v3.x	v4.x	v5.x
		•	•

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(123)		byte
	7	SubFuncStrucLen	(5)		word (Hi-Lo)
	9	SubFunctionCode	(71)		byte
	10	VolumeNumber			long (Lo-Hi)

Reply

	Offset	Content				Type
	(reply header)
	8	FileListCount			long (Lo-Hi)
	12	FileInfoStructure		structure[32]

Completion Code

	0	0x00	Successful

Remarks

This NCP returns a list of files with information being decompressed on a selected volume. The FileListCount parameter contains the number of valid FileInfoStruct entries. A maximum of 32 can be passed in the NCP. The FileInfoStruct structure is defined as follows:

	typedef struct 
	{
		LONG parentDirectoryEntryNumber;
		LONG DirectoryEntryNumber;
		LONG TotalBlocksToDecompress;
		LONG CurrentBlockBeingDecompressed;
	} FileInfoStruct;

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(12)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	DirCacheInfo			structure

Directory Cache Information Structure

	Offset	Content				Type
	  0	MinimumTimeSinceFileDelete	long (Lo-Hi)
	  4	AbsMinimumTimeSinceFileDelete	long (Lo-Hi)
	  8	MinimumNumberOfDirCacheBuffers	long (Lo-Hi)
	 12	MaximumNumberOfDirCacheBuffers	long (Lo-Hi)
	 16	NumberOfDirectoryCacheBuffers	long (Lo-Hi)
	 20	DCMinimumNonReferencedTime	long (Lo-Hi)
	 24	DCWaitTimeBeforeNewBuffer	long (Lo-Hi)
	 28	DCMaximumConcurrentWrites	long (Lo-Hi)
	 32	DCDirtyWaitTime			long (Lo-Hi)
	 36	DCDoubleReadFlag		long (Lo-Hi)
	 40	MapHashNodeCount		long (Lo-Hi)
	 44	SpaceRestrictionNodeCount	long (Lo-Hi)
	 48	TrusteeListNodeCount		long (Lo-Hi)
	 52	PercentOfVolumeUsedByDirs	long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns directory cache information.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The Directory Cache Information structure contains information about the cache. The fields of this structure are defined as follows:

The MinimumTimeSinceFileDelete field contains the minimum time (in ticks) between the deletion of a file and when it can be purged.

The AbsMinimumTimeSinceFileDelete field contains the minimum time (in ticks) between the deletion of a file and when it can be purged when the system has no available blocks.

The MinimumNumberOfDirCacheBuffers field contains the minimum number of directory cache buffers that can be allocated on the server.

This number can be set using the SET console command. Supported values are 10 to 2000; the default value is 20.

The MaximumNumberOfDirCacheBuffers field contains the maximum number of directory cache buffers that can be allocated on the server.

This number can be set using the SET console command. Supported values are 20 to 4000; the default value is 500.

The NumberOfDirectoryCacheBuffers field contains the current number of directory cache buffers on the server.

The DCMinimumNonReferencedTime field contains the time (in ticks) that must elapse between the last reference of a directory buffer and the time it is reused. This value can be set using the SET console command. Supported values are 1 second to 5 minutes; the default value is 5.5 seconds.

The DCWaitTimeBeforeNewBuffer field contains the time (in ticks) that must elapse before an additional directory cache buffer is allocated.

This value can be set using the SET console command. Supported values are 0.5 seconds to 2 minutes; the default value is 2.2 seconds.

The DCMaximumConcurrentWrites field contains the maximum number of write requests from directory cache buffers that can be put in the elevator before they are written to disk. This value can be set using the SET console command. Supported values are 5 to 50; the default value is 10.

The DCDirtyWaitTime field contains the maximum time (in ticks) that the server can wait before writing dirty cache buffers to disk. This value can be set using the SET console command. Supported values are 0 to 10 seconds; the default value is 0.5 seconds.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(02)		byte

ReplyFormat

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved	(0)		word (Lo-Hi)
	 16	NCPStaInUseCnt			long (Lo-Hi)
	 20	NCPPeakStaInUse			long (Lo-Hi)
	 24	NumOfNCPReqs			long (Lo-Hi)
	 28	ServerUtilization		long (Lo-Hi)
	 32++	ServerInfo			structure
	 yy++	FileServerCounters		structure

Server Information Structure

	Offset	Content					Type
	  0	ReplyCanceledCount			long (Lo-Hi)
	  4	WriteHeldOffCount			long (Lo-Hi)
	  8	WriteHeldOffWithDuplicateRequest	long (Lo-Hi)
	 12	InvalidRequestTypeCount			long (Lo-Hi)
	 16	BeingAbortedCount			long (Lo-Hi)
	 20	AlreadyDoingReAllocateCount		long (Lo-Hi)
	 24	DeAllocateInvalidSlotCount		long (Lo-Hi)
	 28	DeAllocateBeingProcessedCount		long (Lo-Hi)
	 32	DeAllocateForgedPacketCount		long (Lo-Hi)
	 36	DeAllocateStillTransmittingCount	long (Lo-Hi)
	 40	StartStationErrorCount			long (Lo-Hi)
	 44	InvalidSlotCount			long (Lo-Hi)
	 48	BeingProcessedCount			long (Lo-Hi)
	 52	ForgedPacketCount			long (Lo-Hi)
	 56	StillTransmittingCount			long (Lo-Hi)
	 60	ReExecuteRequestCount			long (Lo-Hi)
	 64	InvalidSequenceNumberCount		long (Lo-Hi)
	 68	DuplicateIsBeingSentAlreadyCount	long (Lo-Hi)
	 72	SentPositiveAcknowledgeCount		long (Lo-Hi)
	 76	SentADuplicateReplyCount		long (Lo-Hi)
	 80	NoMemoryForStationControlCount		long (Lo-Hi)
	 84	NoAvailableConnectionsCount		long (Lo-Hi)
	 88	ReAllocateSlotCount			long (Lo-Hi)
	 92	ReAllocateSlotCameTooSoonCount		long (Lo-Hi)

File Server Counters Structure

	Offset	Content				Type
	  0	TooManyHops			long (Lo-Hi)
	  2	UnknownNetwork			long (Lo-Hi)
	  4	NoSpaceForService		long (Lo-Hi)
	  6	NoRecieveBuffers		long (Lo-Hi)
	  8	NotMyNetwork			long (Lo-Hi)
	 10	NetBIOSProgatedCount		long (Lo-Hi)
	 14	TotalPacketsServiced		long (Lo-Hi)
	 18	TotalPacketsRouted		long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about a server. The following request format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The NCPStaInUseCnt parameter contains the number of workstations connected to the server.

The NCPPeakStaInUse parameter contains the maximum number of workstations connected at one time since the server was brought up.

The numOfNCPReqs parameter contains the number of NCP requests received by the server since it was brought up.

The serverUtilization parameter contains the current percentage of CPU utilization for the server.

The serverInfo and fileServerCounters parameter contain file server statistical information in the following fields:

ServerInformation structure:

The ReplyCanceledCount field contains the number of replies that were cancelled because the connection was reallocated while the request was being processed.

The WriteHeldOffCount field contains the number of times that writes were delayed because of a pending TTS transaction or cache busy condition.

The InvalidRequestTypeCount field contains the number of packets received which had an invalid request type or were received after the server was downed.

The BeingAbortedCount field contains the number of packets received for a connection that was being terminated.

The AlreadyDoingReAllocateCount field contains the number of times that a connection is requested when a connection already exists.

The DeAllocateInvalidSlotCount field contains the number of times an attempt was made to deallocate a connection slot which was not valid.

The StartStationErrorCount field contains the number of times the server was unable to allocate a connection for whatever reason.

The InvalidSlotCount field contains the number of requests received for an invalid connection slot.

The BeingProcessedCount field contains the number of times a duplicate request was received during processing of the first request.

The ForgedPacketCount field contains the number of suspicious invalid packets received. It is rarely possible to create such packets because of faulty equipment. If this number is large, it may indicate an attempt to breach network security.

The StillTransmittingCount field contains the number of times a new request is received before a reply to a previous request has been sent.

The ReExecuteRequestCount field contains the number of times the requester did not receive the reply and the request had to be reprocessed.

The InvalidSequenceNumberCount field contains the number of request packets the server received from a connection where the sequence number in the packet did not match the current sequence number or the next sequence number. (Packets with bad sequence numbers are discarded). If this number is large, it may indicate an attempt to breach network security.

The DuplicateIsBeingSentAlreadyCount field contains the number of times a duplicate reply was requested when the reply had already been sent.

The SentPositiveAcknowledgeCount field contains the number of acknowledgments sent by the server. An acknowledgment is sent when a connection repeats a request that is being serviced.

The SentADuplicateReplyCount field contains the number of request packets for which the server had to send a duplicate reply. (Duplicate replies are only sent for requests the server cannot process.)

The NoMemoryForStationControlCount field contains the number of times that the server could not allocate memory to expand the connection table for a new connection.

The NoAvailableConnectionsCount field contains the number of times there were no slots available in the connection table for a new connection.

The ReAllocateSlotCount field contains the number of times the server reallocated the same slot in the connection table for a client that logged out and then re-logged in.

The ReAllocateSlotCameTooSoonCount field contains the number of times that a request came from a client to re-log in before that client had been completely logged out.

FileServerCounters structure:

The TooManyHops field contains the number of packets that were discarded because they had passed through more than 16 bridges without reaching their destination.

The UnknownNetwork field contains the number of packets that were discarded because their destination network was unknown to the server.

The NoSpaceForService field is always set to 0 (currently).

The NoRecieveBuffers field contains the number of times a packet was discarded because there were no buffers to receive it.

The NotMyNetwork field contains the number of packets received that were not destined for the server.

The NetBIOSPropagatedCount field contains the number of NetBIOS packets received that were sent forward.

The TotalPacketsServiced field contains the total packets received by the server.

The TotalPacketsRouted field contains the number of all packets forwarded by the server.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(50)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	RIPSocketNumber			long (Lo-Hi)
	 20	RouterDownFlag			long (Lo-Hi)
	 24	TrackOnFlag			long (Lo-Hi)
	 28	ExtRouterActiveFlag		long (Lo-Hi)
	 32	SAPSocketNumber			long (Lo-Hi)
	 36	RpyNearestSrvFlag		long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns router and SAP information. The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. VConsoleVersion and VConsoleRevision track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The RIPSocketNumber parameter contains the router socket number.

The RouterDownFlag parameter indicates whether the internal router is up or down.

The TrackOnFlag parameter indicates whether router tracking is active (the console operator issued the TRACK ON console command).

The ExtRouterActiveFlag parameter indicates whether an external router is active.

The SAPSocketNumber parameter contains the number of the socket that receives SAP packets.

The RpyNearestSrvFlag parameter indicates whether the server will respond to GetNearestServer.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(53)		byte
	 10	StartNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	NumberOfEntries			long (Lo-Hi)
	 20	KnownRoutes			structure

Route Information Structure

	Offset	Content				Type
	  0	NetIDNumber			long (Lo-Hi)
	  4	HopsToNet			word (Lo-Hi)
	  6	NetStatus			word (Lo-Hi)
	  8	TimeToNet			word (Lo-Hi)

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Start Number
	126	0x7E	Invalid Length

Remarks

This NCP returns information about known networks.

The StartNumber parameter specifies the number of the network to begin returning information for.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The NumberOfEntries parameter contains number of entries for which information is returned.

The KnownRoutes parameter contains the structure with route information:

The NetIDNumber field contains the net ID.

The HopsToNet field contains the hops to the net.

The NetStatus field contains router status.

The TimeToNet field contains the time to the net.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(56)		byte
	 10	StartNumber			long (Lo-Hi)
	 14	ServerType			long (Hi-Lo)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	NumberOfEntries			long (Lo-Hi)
	 20+	KnownServStruc			structure

Known Server Information Structure

	Offset	Content				Type
	  0	ServerAddress			byte[12]
	 12	HopsToServer			word (Hi-Lo)
	 14+	ServerName			byte[]

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Start Number or Server Type
	126	0x7E	Invalid Length

Remarks

This NCP returns information about known servers.

The following request format parameters are defined:

The startNumber parameter specifies the number of the server to begin returning information for.

The serverType parameter specifies the type of server to return information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The numberOfEntries parameter contains the number of structures in the buffer.

The info parameter contains the first KnownServerStructure in the buffer. The fields of this structure are defined as follows:

The serverAddress field contains the node address of the known server.

The HopsToServer field contains the number of hops to the server.

The ServerName field contains the first byte of the server name. This field is null terminated.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(47)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	MaxNumOfMedia			long (Lo-Hi)
	 20	MediaListCount			long (Lo-Hi)
	 24+	MediaList			long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

The NCP returns information about loaded media.

The following reply parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The MaxNumOfMedia parameter specifies the maximum number of media.

The MediaListCount parameter is the count of media loaded in the server.

The MediaList parameter is the list of media loaded in the server.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(13)		word (Hi-Lo)
	  9	SubFuncCode	(32)		byte
	 10	StartNumber			long (Lo-Hi)
	 14	ObjectType			long (Lo-Hi)
	 18	ParentObjectNumber		long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved	(0)		word (Lo-Hi)
	 16	nextStartNum			long (Lo-Hi)
	 20	ObjectCount			long (Lo-Hi)
	 24+	Objects				long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	121	0x79	Invalid Start Number, Object Type, or Parent Object Number
	126	0x7E	Invalid Length

Remarks

This NCP returns a list of children belonging to a given media manager parent object.

The following request format parameters are defined:

The startNumber parameter specifies the number to start with. This parameter should be 0 on the first call. On subsequent calls, startNumber should be the value returned in the nextStartNumber field of the GetMMChildListStructure.

The objType parameter specifies the type of object to return information for.

The parentObjectNumber parameter specifies the object number of the media manager object for which you want a list of children.

The objType parameter specifies the type of object. Object types are listed and described below:

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The nextStartNum parameter contains the number to pass as the startNumber parameter on subsequent calls. When this field is 0, all information has been processed.

The objectCount parameter contains the number of child objects that are in the buffer.

The objects parameter contains the ID number of the first media manager child object. More ID numbers follow.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(30)		byte
	 10	ObjectNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	ObjectInformation		structure

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about media manager objects.

The objNumber parameter in the request format specifies the object number of the media manager object that you want information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The ObjectInformation parameter contains the following structure with information about the object.

	struct	GenericInfoDef
	{
		struct	MediaInfoDef	mediainfo;
		LONG			mediatype;
		LONG			cartridgetype;
		LONG			unitsize;
		LONG			blocksize;
		LONG			capacity;
		LONG			preferredunitsize;
		BYTE			name[64];
		LONG			type;
		LONG			status;
		LONG			functionmask;
		LONG			controlmask;
		LONG			parentcount;
		LONG			siblingcount;
		LONG			childcount;
		LONG			specificinfosize;
		LONG			objectuniqueid;
		LONG			mediaslot;
	} GenericStruct;

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(31)		byte
	 10	StartNumber			long (Lo-Hi)
	 14	ObjectType			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	nextStartNum			long (Lo-Hi)
	 20	ObjectCount			long (Lo-Hi)
	 24+	Objects				long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	121	0x79	Invalid Start Number or Object Type
	126	0x7E	Invalid Length

Remarks

This NCP returns a list of media manager objects. The following request format parameters are defined:

The startNumber parmeter specifies the number to start with. This parameter should be -1 for the first call. On subsequent calls, startNumber should be the value returned in the nextStartNum field of the GetMMObjectListsStructure.

The objType parameter specifies the type of object to return information for. Object types are listed and described below:

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The nextStartNum parameter contains the number to be passed as the startNumber parameter on the next call. When this field is 0, all information has been processed.

The objectCount parameter contains the number of media manager objects in the buffer.

The objects parameter contains the ID number of the first media manager object. More ID numbers follow.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(46)		byte
	 10	MediaNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	MediaNameLen			byte
	 17	MediaName			byte[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns a media name for a given media number.

The MediaNumber parameter in the request format specifies the ID number of the media for which you want a name.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The MediaNameLen parameter contains the length of the media name.

The MediaName structure contains the first byte of the media name.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(51)		byte
	 10	NetworkNumber			long (Hi-Lo)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	NetIDNumber			long (Hi-Lo)
	 20	HopsToNetCount			word (Hi-Lo)
	 22	NetStatus			word (Hi-Lo)
	 24	TimeToNet			word (Lo-Hi)

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Network Number
	126	0x7E	Invalid Length

Remarks

This NCP returns information about network routing on a server.

The NetworkNumber parameter in the request format specifies the network to return information for.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The NetIDNumber parameter contains the network ID number.

The HopsToNetCount parameter contains the number of hops to the network.

The NetStatus parameter indicates the status of the network.

The TimeToNet parameter contains the number of ticks to the network (round-trip).

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(52)		byte
	 10	NetworkNumber			long (Hi-Lo)
	 14	StartNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved	(0)		word (Lo-Hi)
	 16	NumberOfEntries			long (Lo-Hi)
	 20+	RoutersInfo			structure

Routers Information Structure

	Offset	Content				Type
	  0	Node				byte[6] 
	  6	Connected LAN			long (Lo-Hi)
	  10	Route Hops			word (Lo-Hi)
	  12	Route Time			word (Lo-Hi)

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Network Number or Start Number
	126	0x7E	Invalid Length

Remarks

This NCP returns information about the routers on a network.

The NetworkNumber parameter specifies the network number to return router information for.

The StartNumber parameters specifies the number to start with.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The numberOfEntries parameter contains the number of RoutersInfoStructure structures in the buffer.

The RoutersInfo parameter contains the first Routers Information structure. More follow. The fields of this structure are defined as follows:

The Node field contains the 6-byte network address of the router.

The ConnectedLAN field contains the LAN board number of the router.

The RouteHops field contains the number of hops to the network specified by networkNumber.

The RouteTime field contains the time (in ticks) to the network specified by networkNumber.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(10)		byte
	 10	StartNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	unused				word (Lo-Hi)
	 16	NLMcount			long (Lo-Hi)
	 20	NLMsInList			long (Lo-Hi)
	 24+	NLMNumbers			long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns a list of NLMs running on a server.

The startNumber parameter in the request format specifies the NLM number to start with.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number.

The VConsoleVersion and VConsoleRevision parameters track packet format.

The VConsoleRevision parameter contains the console version revision number.

The unused field is for future use.

The NLMCount parameter contains the total number of NLMs loaded on the server.

The NLMsInList parameter contains the number of NLMs that are returned in the NLMNumbers list. There can be a maximum of 130 nlm numbers returned in the list.

The NLMNumbers parameter is a list containing the numbers assigned to NLMs loaded on the server.

If the NLMCount is greater than the NLMsInList number, this indicates that there are more NLMs that could not be listed in the buffer. To obtain the rest of the NLMs, call this NCP again, using the last NLM number in the list as the startNumber.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(15)		byte
	 10	NLMNumber			long (Lo-Hi)
	 14	NLMStartNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	TtlNumOfRTags			long (Lo-Hi)
	 20	CurNumOfRTags			long (Lo-Hi)
	 24+	RTagStructures			structure

RTagStructure

	Offset	Content				Type
	  0	RTagNumber			long (Lo-Hi)
	  4	Resource Signature		long (Lo-Hi)
	  8	Resource Count			long (Lo-Hi)
	 12	Resource Name (ASCIIZ)		byte[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns information about resources used by NLMs on a server.

The following request format parameters are defined:

The NLMNumber parameter specifies the number assigned to the NLM by the OS when the NLM was loaded.

The startNumber parameter specifies the resource tag to start with.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. VConsoleVersion and VConsoleRevision track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The totalNumOfRTags parameter contains the total number of resource tags that the NLM is using.

The currentNumOfRTags parameter contains the number of resource tags that the buffer contains. If additional tags are used by the NLM that did not fit in the buffer, call this function again, using the next number as the startNumber.

The RTagStart parameter contains an RTagStructure. This is the first RTagStructure in the buffer. More structures follow, one for each resource tag used on the server. The fields of the RTagStructure are defined as follows:

The rTagNumber field contains the number assigned to the resource tag when it was allocated.

The signature field contains the signature of the resource tag.

The count field contains the number of this kind of tag that has been allocated.

The name field contains the name of the resource tag.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(13)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	OSMajorVersion			byte
	 17	OSMinorVersion			byte
	 18	OSRevision			byte
	 19	AccountVersion			byte
	 20	VAPVersion			byte
	 21	QueueingVersion			byte
	 22	SecurityRestLvl			byte
	 23	BridgingSupport			byte
	 24	MaxNumOfVol			long (Lo-Hi)
	 28	MaxNumOfConn			long (Lo-Hi)
	 32	MaxNumOfUsers			long (Lo-Hi)
	 36	MaxNumOfNmeSps			long (Lo-Hi)
	 40	MaxNumOfLANS			long (Lo-Hi)
	 44	MaxNumOfMedias			long (Lo-Hi)
	 48	MaxNumOfStacks			long (Lo-Hi)
	 52	MaxDirDepth			long (Lo-Hi)
	 56	MaxDataStreams			long (Lo-Hi)
	 60	MaxNumOfSpoolPr			long (Lo-Hi)
	 64	ServerSerial#			long (Lo-Hi)
	 68	ServerApp#			word (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about the NetWare OS version running on the server.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The OSMajorVersion parameter contains the major version number of the OS.

The OSMinorVersion parameter contains the minor version number of the OS.

The OSRevision parameter contains the version revision letter of the OS.

The accountVersion parameter contains the version of the accounting subsystem.

The VAPVersion parameter is not used.

The queueingVersion parameter contains the Queuing version number.

The securityRestLvl parameter contains the Security Restriction version number.

The bridgingSupport parameter contains the Internet Bridge support version number.

The maxNumOfVol parameter contains the maximum number of volumes that can be simultaneously mounted on the server.

The maxNumOfConn parameter contains the maximum number of connections that can be used simultaneously on the server.

The maxNumOfUsers parameter contains the maximum number of simultaneous users allowed on the server.

The maxNumOfnameSpaces parameter contains the maximum number of name spaces that can be simultaneously loaded on a server.

The maxNumOfLANS parameter contains the maximum number of LAN boards that can be used on the server.

The maxNumOfMedias parameter contains the maximum number of different media types allowed on the server.

The maxNumOfStacks parameter contains the maximum number of protocol stacks that can be used in the server.

The maxDirDepth parameter contains the maximum depth of directories that can be used on the server.

The maxDataStreams parameter contains the maximum number of data streams that can be used on the server.

The maxNumOfSpoolPr parameter contains the maximum number of spool printers that can be used on the server.

The serverSerialNumber parameter contains the serial number of the server.

The serverApplicationNumber parameter is included for backward compatibility.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(41)		byte
	 10	StackNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	ConfigMajorVN			byte
	 17	ConfigMinorVN			byte
	 18	StackMajorVN			byte
	 19	StackMinorVN			byte
	 20	ShortStkName			byte[16]
	 36	StackFullNameLen		byte
	 37	StackFullNameStr		byte

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns configuration information about the protocols on a server.

The StackNumber parameter in the request format is the stack number for which configuration information is returned.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. VConsoleVersion and VConsoleRevision track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The ConfigMajorVN parameter contains the major version number of the configuration table.

The ConfigMinorVN parameter contains the minor version number of the configuration table.

The ShortStkName parameter contains the short protocol name (used to register the stack with the LSL):

VIRTUAL_LAN: For use where no Frame ID/MAC envelope is necessary

LOCALTALK: Apple LocalTalk frame

ETHERNET_II: Ethernet using a DEC Ethernet II envelope

ETHERNET_802.2: Ethernet (802.3) using an 802.2 envelope

TOKEN-RING: Token-ring (802.5) using an 802.2 envelope

ETHERNET_802.3: IPX 802.3 raw encapsulation

802.4: Token-passing bus envelope

NOVELL_PCN2: Novell's IBM PC Network II envelope

GNET: Gateway's GNET frame envelope

PRONET-10: Proteon's proNET I/O frame envelope

ETHERNET_SNAP: Ethernet (802.3) using an 802.2 envelope with SNAP

TOKEN-RING_SNAP: Token-ring (802.5) using an 802.2 envelope with SNAP

LANPAC_II: Racore's frame envelope

ISDN: Integrated Services Digital Network

NOVELL_RX-NET: Novell's ARCNET envelope

IBM_PCN2_802.2: IBM PCN2 using 802.2 envelope

IBM_PCN2_SNAP: IBM PCN2 using 802.2 with SNAP envelope

OMNINET/4: Corvus's frame envelope

3270_COAXA: Harris Adacom's frame envelope

IP: IP Tunnel frame envelope

FDDI_802.2: FDDI (802.7) using an 802.2 envelope

IVDLAN_802.9: Commtex, Inc.'s frame envelope

DATACO_OSI: Dataco's frame envelope

FDDI_SNAP: FDDI (802.7) using 802.2 with a SNAP envelope

IBM_SDLC: SDLC tunnel envelope

PCO_FDDITP: PC Office frame envelope

WAIDNET: Hypercommunications

SLIP: Novell frame envelope

PPP: Novell frame envelope

The StackMajorVN parameter contains the major version number of the protocol stack.

The StackMinorVN parameter contains the minor version number of the protocol stack.

The StackFullNameLength parameter contains the length of the full name.

The StackFullNameStr parameter contains the first byte of the full name.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(43)		byte
	 10	StackNumber			long (Lo-Hi)
	 18	CustomStartNum			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	CustomCount			long (Lo-Hi)
	 20+	CustomStruc			(long,byte[])[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns custom information about a protocol stack on a server.

The following request format parameters are defined:

The StackNumber parameter specifies the number of the protocol stack that you want information for.

The CustomStartNumber parameter specifies the custom information structure to start with. For the first call to this function, CustomStartNumber should be 0. On subsequent calls, it should be the next custom information structure that has not been retrieved. All information has been retrieved when no more information is returned.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The CustomCount parameter contains the number of ProtocolCustomInfo structures in the buffer.

The first CustomStruc parameter contains the following information (More structures follow):

The value field contains the value of the custom counter.

The length field contains the length of customData.

The customData field contains the first byte of a string describing the custom counter. The length of the string is length.

Get Protocol Stack Numbers

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(45)		byte
	 10	LanBdNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	StackNumberCount		long (Lo-Hi)
	 20+	StackNumbers			long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns a list of protocol stack ID numbers for a given LAN board.

The LANBdNumber parameter specifies the ID number of the LAN board for which you want a list of protocols.

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The StackIDCount parameter contains the number of protocol stack ID numbers in the buffer.

The StackID parameter contains the first protocol stack ID number in the buffer.

Get Protocol Stack Numbers

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(44)		byte
	 10	MediaNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	StackNumberCount		long (Lo-Hi)
	 20+	StackNumbers			long[] (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

An Invalid Media Number can Abend the server in NW 4.10.

Remarks

This NCP returns a list of protocol stack ID numbers for a given media.

The MediaNumber parameter of the request format specifies the media number (frame number) for which you want protocol stack information. The mediaNumber is the frame ID number of the media:

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The stackIDCount parameter contains the number of protocol stack ID numbers in the buffer.

The stackID parameter contains the first protocol stack ID number in the buffer. More numbers follow.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(42)		byte
	 10	StackNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved				word (Lo-Hi)
	 16	StatMajorVN			byte
	 17	StatMinorVN			byte
	 18	ComCnts	(3)		word (Lo-Hi)
	 20	CounterMask			long (Lo-Hi)
	 24	TotalTxPkts			long (Lo-Hi)
	 28	TotalRxPkts			long (Lo-Hi)
	 32	IgnoredRxPkts			long (Lo-Hi)
	 36	CustomCnts			word (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure

Remarks

This NCP returns protocol statistics for a server.

The StackNumber parameter in the request format specifies the stack number of the protocol stack for which you want information.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format.The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The StatMajorVN parameter contains the major version number of the statistics table.

The StatMinorVN parameter contains the minor version number of the statistics table.

The ComCnts parameter contains the number of counters in the fixed portion of the table.

The CounterMask parameter contains a bit mask indicating which counters are valid (starting with right-most representing the first counter). If the bit is 0, the counter is valid; if it is 1, the counter is not valid.

The TotalTxPkts parameter contains the total number of packets that were requested to be transmitted.

The TotalRxPkts parameter contains the total number of packets that were received.

The IgnoredRxPkts parameter contains the number of incoming packets that were ignored by the stack.

The CustomCts parameter contains the number of custom counters for the protocol stack.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(6+ServerNameLen) word (Hi-Lo)
	  9	SubFuncCode	(54)		byte
	 10	ServerType			long (Lo-Hi)
	 11	ServerNameLen			byte
	 12	ServerName			byte[]

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	ServerAddress			byte[12]
	 28	HopsToServer			word (Hi-Lo)

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Server Name or Server Type
	126	0x7E	Invalid Length

Remarks

This NCP returns information about a server. The following request format parameters are defined:

The ServerType parameter specifies the server type.

The ServerNameLen parameter specifies the length of the server name (name).

The ServerName parameter specifies the name of the server.

The following reply format parameters are defined:

The CurrentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The ServerAddress parameter contains the node address of the server.

The HopsToServer parameter contains the number of hops to the server.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content			Type
	(request header)
	  6	FunctionCode	(123)	byte
	  7	SubFuncStrucLen	(5)	word (Hi-Lo)
	  9	SubFuncCode	(61)	byte
	 10	StartNumber		long (Lo-Hi)

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion		byte
	 13	VConsoleRevision	byte
	 14	reserved		word (Lo-Hi)
	 16	NumberOfSetCategories	long (Lo-Hi)
	 20	NextStartNumber		long (Lo-Hi)
	 24++	CategoryName		byte[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	245	0xF5	Invalid Start Number

Remarks

This NCP returns information about server set categories.

The StartNumber parameter in the request format specifies the number of the server to begin returning information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

NextStartNumber contains the next number of the server to begin returning information for.

NumberOfSetCategories is the number of set categories that are registered on the server.

CategoryName is the category name in ASCIIZ format.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content			Type
	(request header)
	  6	FunctionCode	(123)	byte
	  7	SubFuncStrucLen	(5)	word (Hi-Lo)
	  9	SubFuncCode	(60)	byte
	 10	StartNumber		long (Lo-Hi)

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion		byte
	 13	VConsoleRevision	byte
	 14	reserved		word (Lo-Hi)
	 16	TtlNumOfSetCmds		long (Lo-Hi)
	 20	NextStartNumber		long (Lo-Hi)
	 24	SetCmdType		long (Lo-Hi)
	 28	SetCmdCategory		long (Lo-Hi)
	 32	SetCmdFlags		long (Lo-Hi)
	 36+	SetCmdName		byte[]
	 36+[SetCmdName] SetCmdValue	   byte[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Start Number

Remarks

This NCP returns server set command information.

The StartNumber parameter in the request format specifies the number of the server to begin returning information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The TtlNumOfSetCmds parameter contains the total number of set commands.

The NextStartNumber parameter contains the next number of the server to begin returning information for.

The SetCmdType parameter contains the type of set command.

The SetCmdCategory parameter contains contains the set command category.

The SetCmdFlags parameter contains contains the set command flags.

The SetCmdName parameter contains the set command name. This parameter is a byte string.

The SetCmdValue parameter contains the set command value. This parameter is a byte string or a long, depending on the set command type.

v2.x	v3.x	v4.x	v5.x
			•

Request Format

	Offset	Content			Type
	(request header)
	  6	FunctionCode	(123)	byte
	  7	SubFuncStrucLen	(1+strlen(SetParmName)+1) word (Hi-Lo)
	  9	SubFuncCode	(62)	byte
	 10	SetParmName		BYTE[]

Reply Format

	Offset	Content			Type
	(reply header)
	  8	CurrentServerTime	long (Lo-Hi)
	 12	VConsoleVersion		byte
	 13	VConsoleRevision	byte
	 14	reserved		word (Lo-Hi)
	 16	TtlNumOfSetCmds		long (Lo-Hi)
	 20	NextStartNumber		long (Lo-Hi)
	 24	SetCmdType		long (Lo-Hi)
	 28	SetCmdCategory		long (Lo-Hi)
	 32	SetCmdFlags		long (Lo-Hi)
	 36+	SetCmdName		byte[]
	 36+[SetCmdName] SetCmdValue	   byte[]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Start Number

Remarks

This NCP returns server set command information.

The SubFuncStrucLen parameter in the request packet should be set to 1 + length of the SetParmName + 1. The 2 one byte additions account for the subfunctioncode and null termanating byte of SetParmName.

The SetParmName parameter in the request packet specifies the name of the set parameter you wish to get info for. Note that this parameter is an ASCIIZ string (NULL terminated) and not length preceeded.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The TtlNumOfSetCmds parameter contains the total number of set commands.

The NextStartNumber parameter contains the next number of the server to begin returning information for.

The SetCmdType parameter contains the type of set command.

The SetCmdCategory parameter contains contains the set command category.

The SetCmdFlags parameter contains contains the set command flags.

The SetCmdName parameter contains the set command name. This parameter is a byte string.

The SetCmdValue parameter contains the set command value. This parameter is a byte string or a long, depending on the set command type.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(11)		word (Hi-Lo)
	  9	SubFuncCode	(55)		byte
	 10	StartNumber			long (Lo-Hi)
	 14	ServerType			long (Hi-Lo)
	 18	ServerNameLen			byte
	 19	ServerName			byte[]

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	NumberOfEntries			long (Lo-Hi)
	 20+	ServersSrcInfo			structure

Servers Source Information Structure

	Offset	Content				Type
	  0	ServerNode			byte[6]
	  6	ConnectedLAN			long (Hi-Lo)
	 10	SourceHops			word (Hi-Lo)

Completion Code

	0	0x00	Successful
	1	0x01	Invalid Server Name or Type
	126	0x7E	Invalid Length

Remarks

This NCP returns address information about servers known to a server with a given name.

The following request format parameters are defined:

The StartNumber parameter specifies the number of the server to begin returning information for.

The ServerType parameters specifies the type of server to obtain information for.

The ServerNameLen specifies the length of the server name (name).

THe ServerName parameter specifies the name of the server.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The numberOfEntries parameter contains the number of structures in the buffer.

The info parameter contains the first Server Source Information structure. More follow. The fields of this structure are defined as follows:

The ServerNode field contains the node address of a server.

The ConnectedLAN field contains the LAN board number of the server.

The SourceHops field contains the number of hops to the server.

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(34)		byte
	 10	VolumeNumber			long (Lo-Hi)
	 14	InfoLevelNumber	(see below)	long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved	(0)		word (Lo-Hi)
	 16	InfoLevel			long (Lo-Hi)
	 20+	volumeInformation		byte[]

InfoLevelNumber

Currently Defined as 1 (struct VolInfoDef) or 2 (struct VolInfo2Def).

	struct	VolInfoDef {
		long VolumeType;
		long StatusFlagBits;
		long SectorSize;
		long SectorsPerCluster;
		long VolumeSizeInClusters;
		long FreedClusters;
		long SubAllocFreeableClusters;
		long FreeableLimboSectors;
		long NonFreeableLimboSectors;
		long NonFreeableAvailableSubAllocSectors;
		long NotUsableSubAllocSectors;
		long SubAllocClusters;
		long DataStreamsCount;
		long LimboDataStreamsCount;
		long OldestDeletedFileAgeInTicks;
		long CompressedDataStreamsCount;
		long CompressedLimboDataStreamsCount;
		long UnCompressableDataStreamsCount;
		long PreCompressedSectors;
		long CompressedSectors;
		long MigratedFiles;
		long MigratedSectors;
		long ClustersUsedByFAT;
		long ClustersUsedByDirectories;
		long ClustersUsedByExtendedDirectories;
		long TotalDirectoryEntries;
		long UnUsedDirectoryEntries;
		long TotalExtendedDirectoryExtants;
		long UnUsedExtendedDirectoryExtants;
		long ExtendedAttributesDefined;
		long ExtendedAttributeExtantsUsed;
		long DirectoryServicesObjectID;
		long VolumeLastModifiedDateAndTime;
	};

	struct	VolInfo2Def
	{
		long VolumeActiveCount;
		long VolumeUseCount;
		long MACRootIDs;
		long VolumeLastModifiedDateAndTime;
		long VolumeReferenceCount;
		long CompressionLowerLimit;
		long OutstandingIOs;
		long OutstandingCompressionIOs;
		long CompressionIOsLimit;
	};


Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length
	152	0x98	Disk Map Error or Invalid Volume
	255	0xFF	Failure


Remarks


This NCP returns volume information. The following request format parameters are
defined:

The volumeNumber parameter specifies the volume number to start with.

The InfoLevelNumber is currently defined as 1 (struct VolInfoDef) or 2 (struct
VolInfo2Def).

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this parameter
reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format. The
VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The InfoLevel is currently defined as 1 (struct VolInfoDef) or 2 (struct VolInfo2Def).

The volume information is returned in the VolInfoDef and VolInfo2Dev structures defined
below.

                         VolInfoDef Structure

VolumeType - Specifies the defined type of the current volume.
   NOTE: VolumeType may contain one of the following values:
   0   VINetWare386
   1   VINetWare286
   2   VINetWare386x30
   3   VINetWare386v31

StatusFlagBits - Specifies the options that are currently available on the volume.
   NOTE: StatusFlagbits may contain one or more of the following values:
   0x01   SubAllocEnableBit
   0x02   CompressionEnabledBit
   0x04   MigrationEnableBit
   0x08   AuditingEnabledBit
   0x10   ReadOnlyEnableBit
   0x20   ImmediatePurgeBit
   0x80000000   NSSVolumeBit

SectorSize - Specifies the sector size (in bytes).

SectorsPerCluster - Specifies the number of sectors per cluster or block.

VolumeSizeInClusters - Specifies the size of the volume (in clusters or blocks).

FreedClusters - Specifies the number of clusters or blocks that are currently free 
for allocation (does not include space that is currently available from deleted or 
limbo files, nor space that could be reclaimed from the suballocation file system).

SubAllocFreeableClusters - Specifies the space that can be reclaimed from the suballocation 
file system.

FreeableLimboSectors - Specifies the disk space (in clusters or blocks) that can be 
freed from deleted files.

NonFreeableLimboSectors - Specifies the disk space (in clusters or blocks) that is 
currently in deleted files and is not aged enough to be classified as 
freeableLimboClusters.

NonFreeableAvailSubAllocSectors - Specifies the space available to the suballocation 
file system, but not freeable to return as clusters or blocks.

NotUsableSubAllocSectors - Specifies the disk space that is wasted by the suballocation 
file system. These clusters cannot be allocated by the suballocation system or used a 
regular clusters or blocks.

SubAllocClusters - Specifies the disk space being used by the suballocation file system.

DataStreamsCount - Specifies the number of data streams for real files that have data 
allocated to them.

LimboDataStreamsCount - Specifies the number of data streams for deleted files that have 
data allocated to them.

OldestDeletedFileAgeInTicks - Specifies the current age of the oldest file (in ticks).

CompressedDataStreamsCount - Specifies the number of data streams for compressed real files.

CompressedLimboDataStreamsCount - Specifies the number of data streams for compressed deleted 
files.

UnCompressableDataStreamsCount - Specifies the number of data streams that are not compressable 
(real and deleted).

PreCompressedSectors - Specifies the amount of disk space that was allocated to all files 
before they were compressed (includes "hole" space).

CompressedSectors - Specifies the amount of disk space that is used by all compressed files.

MigratedFiles - Specifies the number of migrated files.

MigratedSectors - Specifies the amount of migrated disk space (in sectors).

ClustersUsedByFAT - Specifies the amount of disk space (in clusters or blocks) being used 
by the FAT table.

ClustersUsedByDirectories - Specifies the amount of disk space (in clusters or blocks) being 
used by directories.

ClustersUsedbyExtendedDirs - Specifies the amount of disk space (in clusters or blocks) being 
used by the extended directory space.

TotalDirectoryEntries - Specifies the total number of directories that are available on the 
volume.

UnUsedDirectoryEntries - Specifies the total number of directory entries that are not in use 
on the volume.

TotalExtendedDirectoryExtants - Specifies the amount of extended directory space extants 
(128 bytes each) that are available on the volume.

UnUsedExtendedDirectoryExtants - Specifies the amount of extended directory space extants 
(128 bytes each) that are not in use on the volume.

ExtendedAttributesDefined - Specifies the number of extended attributes that are defined 
on the volume.

ExtendedAttributeExtantsUsed - Specifies the number of extended directory extants that are 
used by the extended attributes.

DirectoryServicesObjectID - Specifies the NDS ID for the volume.

VolumeLastModifiedDateAndTime - Specifies the last time any file or subdirectory on the 
volume was modified (as tracked by the OS).

                         VolInfo2Def Structure

VolumeActiveCount - Specifies a per-volume count that indicates the volume currently has 
operations in progress that need to be completed before other actions (such as dismounting 
a volume) can be initiated.

VolumeUseCount - Specifies a per-volume count that is incremented before directory cache 
requests and other writes to the directory can begin. This field is decremented when such 
operations complete.

MACRootIDs - Specifies a the DirectoryNumbers of the Macintosh roots.

VolumeLastModifiedDateAndTime - Specifies the last date and time that any subdirectory on 
the volume was modified.

VolumeReferenceCount - Specifies the last modified reference count. This field is increment 
every time that MarkDirectoryChanged is called on the volume.

CompressionLowerLimit - Specifies a value used to determine if a file will be smaller once 
it is compressed. On a volume with suballocation enabled, this value is set to 512; otherwise, 
it is determined (in part) by the defined block size of the volume.

OutstandingIOs - Specifies the number of IO operations that are still in progress and have 
not yet completed.

OutstandingCompressionIOs - Specifies the number of compression-related IO operations that 
are still in progress and have not yet completed.

CompressionIOsLimit - Specifies a per-volume count of the number of IO operations that can 
be dedicated to compression as opposed to the number of regular reading and writing operations.

  
See Also:
  

   

   
0x2222 123 35
Volume Information By Level (64Bit Aware)
   
  



Get Volume Segment List		0x2222  123  33

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(33)		byte
	 10	VolumeNumber			long (Lo-Hi)


Reply Format



	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved	(0)		word (Lo-Hi)
	 16	NumOfSegments			long (Lo-Hi)
	 20	Segments			structure


Volume Segment Structure



	Offset	Content				Type
	  0	VolumeSegmentDeviceNumber;	long (Lo-Hi)
	  4	VolumeSegmentOffset;		long (Lo-Hi)
	  8	VolumeSegmentSize;		long (Lo-Hi)


Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length
	152	0x98	Disk Map Error or Invalid Volume


Remarks


This NCP returns a list of volume segments for a given volume.


The volumeNumber parameter in the request format specifies the volume number of the
volume that you want information for.


The following reply format parameters are defined:


The currentServerTime parameter contains  the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this parameter
reaches 0xFFFFFFFF, it wraps to zero.


The currentServerTime parameter contains  the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this field
reaches 0xFFFFFFFF, it wraps to zero.


The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format. The
VConsoleRevision parameter contains the console version revision number.


The reserved parameter is reserved for future use.


The numOfSegments parameter contains the number of volume segments on the volume.


The segment parameter contains the VolumeSegmentStructure for the first volume
segment. More of these structures follow in the buffer, one for each volume segment.


The Volume Segment structure fields are defined as follows:

    Offset

    Description
 

    0

    VolumeSegmentDeviceNumber;
 

    8

    VolumeSegmentOffset;
 

    12

    VolumeSegmentSize;
 

The VolumeSegmentDeviceNumber field identifies the device that the segment is located
on.


The VolumeSegmentOffset field contains the offset of the segment in bytes.


The VolumeSegmentSize field contains the segment size in bytes.

IPX SPX Information			0x2222  123  06

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(06)		byte


Reply Format



	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16++	IPXInformation			structure
	 zz++	SPXInformation			structure


IPX Information Structure



	Offset	Content				Type
 	  0	IpxSendPacketCount		(Lo-Hi)
 	  4	IpxMalformPacketCount		(Lo-Hi)
 	  6	IpxGetECBRequestCount		(Lo-Hi)
	 10	IpxGetECBFailCount		(Lo-Hi)
	 14	IpxAESEventCount		(Lo-Hi)
	 18	IpxPostponedAESCount		(Lo-Hi)
	 20	IpxMaxConfiguredSocketCount	(Lo-Hi)
	 22	IpxMaxOpenSocketCount		(Lo-Hi)
	 24	IpxOpensocketFailCount		(Lo-Hi)
	 26	IpxListenECBCount		(Lo-Hi)
	 30	IpxECBCancelFailCount		(Lo-Hi)
	 32	IpxGetLocalTargetFailCount	(Lo-Hi)


SPX Information Structure



	Offset	Content				Type
	0	SpxMaxConnectionsCount		(Lo-Hi)
  	2	SpxMaxUsedConnections		(Lo-Hi)
  	4	SpxEstConnectionReq		(Lo-Hi)
  	6	SpxEstConnectionFail		(Lo-Hi)
  	8	SpxListenConnectReq		(Lo-Hi)
  	10	SpxListenConnectFail		(Lo-Hi)
  	12	SpxSendCount			(Lo-Hi)
  	16	SpxWindowChokeCount		(Lo-Hi)
  	20	SpxBadSendCount			(Lo-Hi)
  	22	SpxSendFailCount		(Lo-Hi)
  	24	SpxAbortedConnection		(Lo-Hi)
  	26	SpxListenPacketCount		(Lo-Hi)
  	30	SpxBadListenCount		(Lo-Hi)
  	32	SpxIncomingPacketCount		(Lo-Hi)
  	36	SpxBadInPacketCnt		(Lo-Hi)
  	38	SpxSuppressedPackCnt		(Lo-Hi)
  	40	SpxNoSesListenECBCnt		(Lo-Hi)
  	42	SpxWatchDogDestSesCnt		(Lo-Hi)


Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length


Remarks


This NCP returns information about IPX/SPX use on a server.


The following reply format parameters are defined:


The currentServerTime parameter contains the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this parameter
reaches 0xFFFFFFFF, it wraps to zero.


The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format. The
VConsoleRevision parameter contains the console version revision number.


The reserved parameter is reserved for future use.


The IPXInfo parameter contains an IPXInformation structure. The fields of this structure
are defined as follows:


The IpxSendPacketCount field contains the number of IPX packets sent by the server.


The IpxMalformPacketCount field contains the number of IPX packets discarded because
they were malformed.


The IpxGetECBRequestCount field contains the number of ECB requests.


The IpxGetECBFailCount field contains the number of times an ECB was requested but
could not be supplied.


The IpxAESEventCount field contains the number of AES events scheduled.


The IpxPostponedAESCount field contains the number of AES events that could not be
scheduled and were placed in a waiting list.

The IpxMaxConfiguredSocketCount field contains the maximum number of sockets that
can be open at one time.


The IpxMaxOpenSocketCount field contains the maximum number of sockets open at
one time since the server was brought up.


The IpxOpensocketFailCount field contains the number of times a request to open a
socket failed.


The IpxListenECBCount field contains the number of ECBs listening for a packet.


The IpxECBCancelFailCount field contains the number of ECB listens that were
cancelled.


The IpxGetLocalTargetFailCount field contains the number of times that the server failed
to find the target.


The SPXInfo field contains an SPXInformation structure. The fields of this structure are
defined as follows:


The SpxMaxConnectionsCount field contains the maximum number of SPX connections
allowed on the server.


The SpxMaxUsedConnections field contains the maximum number of SPX connections
used at one time since the server was brought up.


The SpxEstConnectionReq field contains total number of SPX connections established
since the server was brought up.


The SpxEstConnectionFail field contains number of times that an attempt to establish an
SPX connection failed since the server was brought up.


The SpxListenConnectReq field contains the number of requests to post a listen since the
server was brought up.


The SpxListenConnectFail field contains the number of times a request to post a listen
failed since the server was brought up.

The SpxSendCount field contains the number of SPX packets sent since the server was
brought up.


The SpxWindowChokeCount field contains a value used internally for debugging.


The SpxBadSendCount field contains the number of bad packets sent since the server was
brought up.


The SpxSendFailCount field contains the number of packets sent for which no
acknowledgment was received since the server was brought up.


The SpxAbortedConnection field contains the number of times a connection was aborted
since the server was brought up.


The SpxListenPacketCount field contains the number of times a listen was posted on a
socket since the server was brought up.


The SpxBadListenCount field contains the number of times a listen on a socket failed for
whatever reason (for example, it was cancelled) since the server was brought up.


The SpxIncomingPacketCount field contains the number of packets in the queue.


The SpxBadInPacketCnt field contains the number of bad SPX packets received since the
server was brought up.


The SpxSuppressedPackCnt field contains the number of times a duplicate SPX packet
was received.


The SpxNoSesListenECBCnt field contains the number of times a listen was posted on a
session that was not established since the server was brought up.


The SpxWatchDogDestSesCnt field contains the number of times the watchdog destroyed
a session since the server was brought up.

LAN Common Counters Information	0x2222  123  22

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(22)		byte
	 10	BoardNumber			long (Lo-Hi)
	 14	BlockNumber			long (Lo-Hi)


Reply Format



	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	StatMajorVersion		byte
	 15	StatMinorVersion		byte
	 16	TotalCommonCnts			long (Lo-Hi)
	 20	TotalCntBlocks			long (Lo-Hi)
	 24	CustomCounters			long (Lo-Hi)
	 28	NextCntBlock			long (Lo-Hi)
	 32+	CommonLanStruc			structure


LAN Common Counters Structure


	EtherNet Definition (TotalCounters = )



	Offset	Content				Type
  	0	NotSupportedMask		(Lo-Hi)
  	4	TotalTxPacketCount		(Lo-Hi)
  	8	TotalRxPacketCount		(Lo-Hi)
 	12	NoECBAvailableCount		(Lo-Hi)
 	16	PacketTxTooBigCount		(Lo-Hi)
 	20	PacketTxTooSmallCount		(Lo-Hi)
 	24	PacketRxOverflowCount		(Lo-Hi)
 	28	PacketRxTooBigCount		(Lo-Hi)
 	32	PacketRxTooSmallCount		(Lo-Hi)
 	36	PacketTxMiscErrorCount		(Lo-Hi)
 	40	PacketRxMiscErrorCount		(Lo-Hi)
 	44	RetryTxCount			(Lo-Hi)
 	48	ChecksumErrorCount		(Lo-Hi)
 	52	HardwareRxMismatchCount		(Lo-Hi)


Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Board or Block Number


Remarks


This NCP returns common statistics for a LAN board.


The following request format parameters are defined:


The boardNumber parameter specifies the board number of the LAN board for which you
want information.


The blockNumber parameter specifies the block number to start with. On the first call to
this NCP this value should be 0. On subsequent calls this value should be the value that is
returned in the nextCntBlock field of the GetLANCommonCountersStructure.

The currentServerTime parameter contains the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When the value in this
parameter reaches 0xFFFFFFFF, it wraps to zero.


The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format. The
VConsoleRevision parameter contains the console version revision number.


The statMajorVersion parameter contains the major version number of the generic portion
of the statistics table (defined by Novell).


The statMinorVersion parameter contains the minor version number of the generic
portion of the statistics table (defined by Novell).


The totalCommonCnts parameter contains the number of LAN common counters.


The totalCntBlocks parameter contains the total number of blocks used by LAN common
counters for the specified LAN board.


The customCounters parameter contains the number of LAN custom counters.


The nextCntBlock parameter contains the value to be passed in blockNumber on the next
call to this function. When 0 is returned in this field, all common counters have been
returned.


The info field contains a CommonLANStructure which is defined as follows:


The notSupportedMask field contains a bit mask representing the fields in the statistics
table. If the bit is 0, the counter is supported; if it is 1, the counter is not supported.


The TotalTxPacketCount field contains the total number of packets transmitted by the
LAN board.


The TotalRxPacketCount field contains the total number of packets that were received by
the LAN board.


The NoECBAvailableCount field contains the number of times the LAN board failed to
get a receive ECB.

The PacketTxTooBigCount field contains the number of times the send packet was too
big for this LAN board to send.


The PacketTxTooSmallCount field contains the number of times the send packet was too
small for this LAN board to send.


The PacketRxOverflowCount field contains the number of times the LAN board's receive
buffers overflowed.


The PacketRxTooBigCount field contains the number of times this LAN board could not
receive a packet because the packet was too big.


The PacketRxTooSmallCount field contains the number of times this LAN board could
not receive a packet because the packet was too small.


The PacketTxMiscErrorCount field contains the number of times any kind of transmit
error occurred for the LAN board.


The PacketRxMiscErrorCount field contains the number of times any kind of receive
error occurred for the LAN board.


The RetryTxCount field contains the number of times the LAN board retried a transmit
because of failure.


The ChecksumErrorCount field contains the number of times a checksum error occurred
for the LAN board.


The HardwareRxMismatchCount field contains a counter which may be incremented
when a packet is received which does not pass length consistency checks (currently used
only by the Ethernet TSU).

LAN Configuration Information	0x2222  123  21

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(21)		byte
	 10	BoardNumber			long (Lo-Hi)


Reply Format



	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	LANConfigInfo			structure


LAN Configuration Information Structure



	Offset	Content				Type
	  0	LANdriverCFG_MajorVersion	(Lo-Hi)
	  1	LANdriverCFG_MinorVersion	(Lo-Hi)
	  2	LANdriverNodeAddress		(Lo-Hi)
	  8	LANdriverModeFlags		(Lo-Hi)
	 10	LANdriverBoardNumber		(Lo-Hi)
	 12	LANdriverBoardInstance		(Lo-Hi)
	 14	LANdriverMaximumSize		(Lo-Hi)
	 18	LANdriverMaxRecvSize		(Lo-Hi)
	 22	LANdriverRecvSize		(Lo-Hi)
	 26	LANdriverCardID			(Lo-Hi)
	 28	LANdriverMediaID		(Lo-Hi)
	 30	LANdriverTransportTime		(Lo-Hi)
	 32	LANdriverSrcRouting		(Lo-Hi)
	 36	LANdriverLineSpeed		(Lo-Hi)
	 38	LANdriverReserved		(Lo-Hi)
	 40	LANdriverMajorVersion		(Lo-Hi)
	 41	LANdriverMinorVersion		(Lo-Hi)
	 42	LANdriverFlags			(Lo-Hi)
	 44	LANdriverSendRetries		(Lo-Hi)
	 46	LANdriverLink			(Lo-Hi)
	 50	LANdriverSharingFlags		(Lo-Hi)
	 52	LANdriverSlot			(Lo-Hi)
	 54	LANdriverIOPortsAndRanges	(Lo-Hi)
	 62	LANdriverMemoryDecode0		(Lo-Hi)
	 66	LANdriverMemoryLength0		(Lo-Hi)
	 68	LANdriverMemoryDecode1		(Lo-Hi)
	 72	LANdriverMemoryLength1		(Lo-Hi)
	 74	LANdriverInterrupt		(Lo-Hi)
	 76	LANdriverDMAUsage		(Lo-Hi)
	 78	LANdriverLogicalName		(Lo-Hi)
	 96	LANdriverIOReserved		(Lo-Hi)
	110	LANdriverCardName		(Lo-Hi)
	238	LANdriverShortName		(Lo-Hi)
	278	LANdriverMediaType		(Lo-Hi)
	318	LANCustomVariablesCount 	(Lo-Hi)


Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Board Number


Remarks


This NCP returns LAN configuration information. 


The BoardNumber parameter in the request format specifies the LAN board number to
start with.


The following reply format parameters are defined:


The currentServerTime parameter contains the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this field
reaches 0xFFFFFFFF, it wraps to zero.


The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format. The
VConsoleRevision parameter contains the console version revision number.


The reserved parameter is reserved for future use.


TheLANConfig parameter contains a LAN Configuration Information Structure. Its fields
are defined as follows:


The LANdriverCFG_MajorVersion field contains the Novell-defined major version
number of the configuration table.


The LANdriverCFG_MinorVersion field contains the Novell-defined minor version of
the configuration table.


The LANdriverNodeAddress field contains the node address of the LAN board.


The LANdriverModeFlags field contains the modes supported by the driver. 

The bits are defined as follows:


Bits 14 and 15 in DriverModeFlags describe the format of DriverNodeAddress. The
combinations are as follow:

    Value

    Description
 

    00

    Format is unspecified-The node address is assumed to be in the
    physical layer's native format
 

    01

    This is an illegal combination and should not occur.
 

    10

    DriverNodeAddress is canonical.
 

    11

    DriverNodeAddress is non-canonical.
 

The LANdriverBoardNumber field contains the logical board number (1 - 255) assigned
to the LAN board by the LSL.


The LANdriverBoardInstance field contains the number of the physical card that the
logical board is using. If a driver is driving one physical card, all the logical boards using
this card would have a value of 1 in this field. If a second physical card is added, all the
logical boards using the second physical card would have a value of 2 in this field.


The LANdriverMaximumSize field contains the maximum send or receive packet size (in
bytes) that the LAN board can transmit or receive.


The LANdriverMaxRecvSize field contains the maximum packet size (or best size) in
bytes that the LAN board can receive.


The LANdriverRecvSize field contains the maximum packet size (in bytes) a protocol
stack can send or receive using this board.


The LANdriverCardID field contains the number assigned to the LAN board by the
IMSP.


The LANdriverMediaID field contains a number identifying the link-level envelope
(frame ID) used by the MLID. The above table lists defined ID numbers.


The LANdriverTransportTime field contains the time (in ticks) that it takes for the LAN
board to transmit a 576-byte packet.

The LANDriverSrcRouting field contains source router information.


The LANDriverLineSpeed field contains the line speed.


The LANdriverReserved field is reserved for future use (currently set to 0).


The LANdriverMajorVersion field contains the major version number of the MLID.


The LANdriverMinorVersion field contains the minor version number of the MLID.


The LANdriverFlags field contains a bit map indicating the architecture supported by
MLID:


Bits 9 and 10 in LANdriverFlags indicate different support mechanisms for multicast
filtering and format. The combinations are as follow:


00		The method used for group addressing support defaults to that of the LAN
medium. For example, for Ethernet it is the Hash Table; for Token-Ring it is
the Functional Address.

    Value

    Description
 

    01

    This is an illegal combination and should not occur
 

    10

    Group addressing is supported by a specialized adapter, but the
    TSM should filter the addresses.
 

    11

    Group addressing is supported by a specialized adapter, and TSM
    checking is not required.
 

The LANdriverSendRetries field contains the number of times that the MLID retries send events before aborting the send.


The LANdriverLink field is used by the LSL.


The LANdriverSharingFlags field contains a bit map defining the sharing abilities of the
MLID:


The LANdriverSlot field contains the slot number where the LAN board is installed if the
board is running in an MCA or EISA machine. Otherwise, this field is 0.

The LANdriverIOPortsAndRanges field contains I/O port information as follows:

1st WORD	The primary base I/O port for the LAN board

2nd WORD	The number of I/O ports beginning with the primary base I/O port

3rd WORD	The secondary base I/O port for the LAN board

4th WORD	The number of I/O ports beginning with the secondary base I/O port

The LANdriverMemoryDecode0 field contains the absolute primary memory address that
the LAN board uses (if not used, this field is 0).


The LANdriverMemoryLength0 field contains the amount of memory (in paragraphs) that
the LAN board uses, starting at DriverMemoryDecode0 (if not used, this field is 0).


The LANdriverMemoryDecode1 field contains the absolute secondary memory address
that the LAN board uses (if not used, this field is 0).


The LANdriverMemoryLength1 field contains the amount of memory (in paragraphs) that
the LAN board uses, starting at DriverMemoryDecode0 (if not used, this field is 0).


The first byte in the LANdriverInterrupt field contains the primary interrupt vector
number. The second byte in this field contains the secondary interrupt vector number.
FFh = not used.


The first byte in the LANdriverDMAUsage field contains the primary DMA channel used
by the LAN board. The second byte in this field contains the secondary DMA channel
used by the LAN board. FFh = not used.


The LANdriverLogicalName field contains the logical name of the LAN driver (given at
load time).


The LANdriverIOReserved field is reserved for the LSL.


The LANdriverCardName field contains a pointer to a length-preceded, zero-terminated
ASCII description string that is contained in the OSDATA segment and is similar to the
description string in the definition table. For example, "NE2000 ETHERNET Driver".

The LANdriverShortName field contains a pointer to a length-preceded, zero-terminated
ASCII string that describes the LAN board in eight bytes or less, such as "NE2000".


The LANdriverMediaType field contains a pointer to a length-preceded, zero-terminated
string that describes the MLID's frame type (for example, "ETHERNET_802.3"). The
Independent Manufacturer Support Program (IMSP) assigns strings for the frame type.
The following table summarizes frame types currently defined by Novell with their
corresponding protocol ID numbers for IPX.


Frame ID	Frame Type		Protocol	Description

String	on IPX/SPX		ID

    Frame ID

    String

    Frame Type

    on IPX/SPX

    Protocol

    ID

    Description
 

    0

    VIRTUAL_LAN

    00h

    For use where no Frame ID/MAC envelope is necessary
 

    1

    LOCALTALK

    00h

    Apple LocalTalk frame
 

    2

    ETHERNET_II

    8137h

    Ethernet using a DEC Ethernet II envelope
 

    3

    ETHERNET_802.2

    E0h

    Ethernet (802.3) using an 802.2 envelope
 

    4

    TOKEN-RING

    E0h

    Token-ring (802.5) using an 802.2 envelope
 

    5

    ETHERNET_802.3

    00h

    IPX 802.3 raw encapsulation
 

    6

    802.4

    N/A

    Token-passing bus envelope
 

    7

    NOVELL_PCN2

    1111h

    Novell's IBM PC Network II envelope
 

    8

    GNET

    E0h

    Gateway's GNET frame envelope
 

    9

    PRONET-10

    N/A

    Proteon's proNET I/O frame envelope
 

    10

    ETHERNET_SNAP

    8137h

    Ethernet (802.3) using an 802.2 envelope with SNAP
 

    11

    TOKEN-RING_SNAP

    8137h

    Token-ring (802.5) using an 802.2 envelope with SNAP
 

    12

    LANPAC_II

    N/A

    Racore's frame envelope
 

    13

    ISDN

    N/A

    Integrated Services Digital Network
 

    14

    NOVELL_RX-NET

    FAh

    Novell's ARCNET envelope
 

    15

    IBM_PCN2_802.2

    E0h

    IBM PCN2 using 802.2 envelope
 

    16

    IBM_PCN2_SNAP

    8137h

    IBM PCN2 using 802.2 with SNAP envelope
 

    17

    OMNINET/4

    N/A

    Corvus's frame envelope
 

    18

    3270_COAXA

    N/A

    Harris Adacom's frame envelope
 

    19

    IP

    N/A

    IP Tunnel frame envelope
 

    20

    FDDI_802.2

    E0h

    FDDI (802.7) using an 802.2 envelope
 

    21

    IVDLAN_802.9

    N/A

    Commtex, Inc.'s frame envelope
 

    22

    DATACO_OSI

    N/A

    Dataco's frame envelope
 

    23

    FDDI_SNAP

    8137h

    FDDI (802.7) using 802.2 with a SNAP envelope
 

    24

    IBM_SDLC

    N/A

    SDLC tunnel envelope
 

    25

    PCO_FDDITP

    N/A

    PC Office frame envelope
 

    26

    WAIDNET

    N/A

    Hypercommunications
 

    27

    SLIP

    N/A

    Novell frame envelope
 

    28

    PPP

    N/A

    Novell frame envelope
 

LAN Custom Counters Information	0x2222  123  23

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(9)		word (Hi-Lo)
	  9	SubFuncCode	(23)		byte
	 10	BoardNumber			long (Lo-Hi)
	 14	StartNumber			long (Lo-Hi)


Reply Format



	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	Unused			        word 
	 16	NumOfCCinPkt			long (Lo-Hi)
	 20+	CustomCntsInfo			(long,STRING)[]


Custom Counters Information

 

    Offset

    Content
 

    0

    Custom Variable Value
 

    4

    Custom String Length
 

    5

    Custom String
 

Completion Code


	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Start or Board Number


Remarks

This NCP returns custom statistics for a LAN board. LAN custom counters keep track of
such things as the number of raw sends and fatal retransmissions. Each counter has a
string describing the counter and a value associated with the counter. 

To ensure that all information is returned, make the NCP request once. Then use the number returned in the 
NumOfCCinPkt field as the StartNumber for a second request. Issue the request a third time to ensure that
all the information was returned. You can also check that all the information is returned by adding the total
number of Custom Counters that are returned for each request in the NumOfCCinPkt field. If the StartNumber of 
your last request is greater than or equal to the total number of Custom Counters, the NCP request will return 
an error of -1, which indicates that you've received all the information.

The following request format parameters are defined:
	
The boardNumber parameter specifies the number of the LAN board to return counters
for.
	
The startNumber parameter specifies the custom counter number to start with. Initially,
this should be set to 0.

The following reply format parameters are defined:
	
The currentServerTime parameter contains the time elapsed since the server was brought
up. This time is returned in ticks (approximately 1/18 of a second). When this parameter
reaches 0xFFFFFFFF, it wraps to zero.
	
The VConsoleVersion parameter contains the console version number. The
VConsoleVersion and VConsoleRevision parameters track packet format.
	
The VConsoleRevision parameter contains the console version revision number.
	
The Unused parameter is reserved for future use.
	
The NumOfCCinPkt parameter contains the number of custom counters used
by the LAN driver.
	
The CustomCntsInfo parameter contains the first byte of a number of Custom
Counters Information structures in the buffer.

The fields of the Custom Counter Information structure are defined as follows:
	
The value field contains the value of the custom counter.
	
The stringLength field contains the length of the string that starts with stringStart. If the
stringLength is zero, there is no string following.
	
The customString field contains the first byte of a string that describes the custom
counter.



LAN Name Information			0x2222  123  24

 
v2.x
v3.x
v4.x
v5.x


•
•



Request Format



	Offset	Content				Type
	(request header)
	 6	FunctionCode	(123)		byte
	 7	SubFuncStrucLen	(5)		word (Hi-Lo)
	 9	SubFuncCode	(24)		byte
	10	BoardNumber			long (Lo-Hi)


Reply Format



	Offset	Content				Type
	(reply header)
	 8	CurrentServerTime		long (Lo-Hi)
	12	VConsoleVersion			byte
	13	VConsoleRevision		byte
	14	reserved		  	word (Lo-Hi)
	16+	BoardName			structure


BoardName Structure



	Offset	Content				Type
	 0+   DriverBoardName String		byte[]
	 xx+  DriverShortName String		byte[]
	 yy+  DriverLogicalName String		byte[]

Remarks

This NCP returns LAN Name information. The following return parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The BoardName structure can contain 3 ASCIIZ strings if defined by the LAN driver bound to the specifed board. The 3 strings are as follows:

The DriverBoardName string contains the LAN driver full name bound to the board. It is a NULL terminated string. If no name is present, then a NULL byte will replace it.

The DriverShortName string contains the LAN driver short name bound to the board. It is a NULL terminated string. If no name is present, then a NULL byte will replace it.

The DriverLogicalName string contains the LAN driver logical name bound to the board. This name is specified when loading the driver and using a "name=" on the command line. It is a NULL terminated string. If no name is present, then a NULL byte will replace it.

See Also

LAN Configuration Information (0x2222 123 21)

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(25)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	LSLInformation			structure

LSL Informaiton Structure

	Offset	Content				Type
 	  0	RxBuffers			(Lo-Hi)
 	  4	RxBuffers75%			(Lo-Hi)
 	  8	RxBuffersCheckedOutCount	(Lo-Hi)
	 12	RxBufferSize			(Lo-Hi)
	 16	MaximumPhysicalPacketSize	(Lo-Hi)
	 20	LastTimeRxBufferWasAllocated	(Lo-Hi)
	 24	MaximumNumberOfProtocols	(Lo-Hi)
	 28	MaximumNumberOfMediaTypes	(Lo-Hi)
	 32	TotalTXPackets			(Lo-Hi)
	 36	GetECBBfrs			(Lo-Hi)
	 40	GetECBFails			(Lo-Hi)
	 44	AESEventCounts			(Lo-Hi)
	 48	PostpondedEvents		(Lo-Hi)
	 52	ECBCxlFails			(Lo-Hi)
	 56	ValidBfrsReused			(Lo-Hi)
	 60	EnqueuedSendCnt			(Lo-Hi)
	 64	TotalRXPackets			(Lo-Hi)
	 68	UnclaimedPackets		(Lo-Hi)
	 72	StatTableMajorVersion		(Lo-Hi)
	 73	StatTableMinorVersion		(Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about the LSL.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The LSLInfo parameter contains an LSLInformation structure. The fields of this structure are defined as follows:

The RxBufs field contains the total number of LSL receive buffers.

The RxBufs75PerCent field contains the number of LSL receive buffers that must be in use before a warning message is issued that buffers are getting low.

The RxBufsCheckedOut field contains the number of LSL buffers in use.

The RxBufMaxSize field contains the size of the data portion of the ECBs in bytes.

The MaxPhysicalSize field contains the total size of the ECB in bytes.

The LastTimeRxBufAllocated field contains the last time (in ticks since the server was brought up) a buffer was checked out.

The MaxNumbersOfProtocols field contains the number of protocol stacks supported by the OS.

The MaxNumbersOfMediaTypes field contains the number of frame types supported by the OS.

The TotalTXPackets field contains the number of packet transmit requests.

The GetECBBfrs field contains the number of ECBs that were requested.

The GetECBFails field contains the number of times an ECB request failed.

The AESEventCounts field contains the total number of AES events that have been processed.

The PostpondedEvents field contains the total number of AES events postponed because of critical sections.

The ECBCxlFails field contains the number of AES cancel requests that failed because the event was not found on the AES list.

The ValidBfrsReused field contains the number of ECBs in the hold queue that were reused before they were removed from the hold queue.

The EnqueuedSendCnt field contains the number of send events in the queue that have occurred.

The TotalRXPackets field contains the total number of received incoming packets.

The UnclaimedPackets field contains the total number of unclaimed incoming packets.

The StatisticsTableMajorVersion field contains the major version of the LSL statistics table.

The StatisticsTableMinorVersion field contains the minor version of the LSL statistics table.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(26)		byte
	 10	LanBoardNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	LogTtlTxPkts			long (Lo-Hi)
	 20	LogTtlRxPkts			long (Lo-Hi)
	 24	UnclaimedPkts			long (Lo-Hi)
	 28	reserved			long (Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid LAN Board Number

Remarks

This NCP returns information about LSL logical boards.

The LANboardNumber parameter in the request format specifies the board number to return information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The LogTtlTxPackets parameter contains the total number of packets transmitted.

The LogTtlRxPackets parameter contains the total number of packets received.

The UnclaimedPackets parameter contains the total number of unclaimed packets.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(27)		byte
	 10	MLIDBoardNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			byte
	 15	reserved (4.x)			byte	(If Netware 4.x)
	 15	numberOfProtocols (5.x)		byte	(If Netware 5.x)
	 16	MLIDBoardInfo			structure

MLID Board Information

	Offset	Content				Type
	 0	ProtocolBoardNum		long
	 4	ProtocolNumber			word
	 6	ProtocolID			byte[6]
	 7	ProtocolName			byte[16]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid LAN Board Number

Remarks

This NCP returns MLID board information. The MLIDBoardNumber parameter in the request format specifies the board number to return information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The numberOfProtocols parameter returns the number of protocols bound to the specified board. (NetWare 5.x only) The reply buffer will contain that number of MLIDBoardInfo structures. If the server is NetWare 4.x, then only one MLIDBoardInfo structure will be returned.

The MLIDBoardInfo parameter contains an MLIDBoardInfo structure. The fields of this structure are defined as follows:

The ProtocolBoardNum is the board number the protocol is using.

The ProtocolNumber is the protocol number.

The ProtocolID is the protocol ID and is a fixed length 6 byte string.

The ProtocolName is the protocol name. It is a length preceeded 16 byte string.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(03)		byte

ReplyFormat (NetWare 3.x File System)

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	FileSystemInfo			structure

NetWare 3.x File System Information Structure

	Offset	Content				Type
	  0	FATMovedCount			(Lo-Hi)
	  4	FATWriteErrorCount		(Lo-Hi)
	  8	SomeoneElseDidItCount0		(Lo-Hi)
	 12	SomeoneElseDidItCount1		(Lo-Hi)
	 16	SomeoneElseDidItCount2		(Lo-Hi)
	 20	IRanOutSomeoneElseDidItCount	(Lo-Hi)
	 24	IRanOutSomeoneElseDidItCount1	(Lo-Hi)
	 28	IRanOutSomeoneElseDidItCount2	(Lo-Hi)
	 32	TurboFATBuildScrewedUpCount	(Lo-Hi)
	 36	ExtraUseCountNodeCount		(Lo-Hi)
	 40	ExtraExtraUseCountNodeCount	(Lo-Hi)
	 44	ErrorReadingLastFATCount	(Lo-Hi)
	 48	SomeoneElseUsingThisFileCount	(Lo-Hi)

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns information about a server's file system.

The following request format parameters are defined:

The FileSystemID parameter specifies the ID number of the file system for which information is returned. Currently this value is always 1 (for 386).

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The File System Info Structure fields are defined as follows:

FATMovedCount - Specifies the number of times the NetWare server OS has moved the location of the FAT.

FATWriteErrorCount - Specifies the number of disk write errors in both the original and mirrored copy of a disk's FAT sector.

SomeoneElseDidItCount0 - Specifies this is used internally by the OS.

SomeoneElseDidItCount1 - Specifies this is used internally by the OS.

SomeoneElseDidItCount2 - Specifies this is used internally by the OS.

IRanOutSomeoneElseDidItCount0 - Specifies this is used internally by the OS.

IRanOutSomeoneElseDidItCount1 - Specifies this is used internally by the OS.

IRanOutSomeoneElseDidItCount2 - Specifies this is used internally by the OS.

TurboFATBuildScrewedUpCount - Specifies the number of times the OS tried to allocate a Turbo FAT index but failed.

ExtraUseCountNodeCount - Specifies the number of times the OS tried to allocate a use count node for a TTS transaction but failed.

ExtraExtraUseCountNodeCount - Specifies the number of times the OS tired to allocate an additional use count node for a TTS transaction but failed.

ErrorReadingLastFATCount - Specifies the number of times the OS received an error reading the data in the last FAT.

SomeoneElseUsingThisFileCount - Specifies the number of times the OS was reading a file that another process was also reading.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(11)		byte
	 10	NLMNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	NLMInformaiton			structure
	 xx+	FileNameLen			byte
	 yy+	FileName			byte[]
	 uu+	NameLen				byte
	 vv+	Name				byte[]
	 ww+	CopyrightLen			byte
	 zz+	Copyright			byte[]

NLM Information Structure

	Offset	Content				Type
	0	IdentificationNumber		long
	4	Flags				long
	8	Type				long
	12	ParentID			long
	16	MajorVersion			long
	20	MinorVersion			long
	24	Revision			long
	28	Year				long
	32	Month				long
	36	Day				long
	40	AllocAvailBytes			long
	44	AllocFreeCount			long
	48	LastGarbCollect			long
	52	MessageLanguage			long
	56	NumberOfReferencedPublics	long

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid NLM Number

Remarks

This NCP returns information about an NLM running on a server for the current connection.

The NLMNumber parameter specifies the number assigned to the NLM by the OS when the NLM was loaded. This number can be obtained by calling NCP 0x2222 123 10 (Get NLM Loaded List.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The NLMInformation parameter contains an NLMInformation structure.

The FileNameLen and FileName parameters contain the length and name of the NLM file.

The NameLen and Name parameters contain the length and name of the NLM.

The CopyrightLen and Copyright parameters contain the length and name of the copyright.

The fields of the NLMInformation structure are defined as follows:

The nlmIdentificationNumber field contains the number assigned to the NLM when it was loaded.

The nlmFlags field contains a bit mask with a combination of the following:

0x0001 REENTRANT:

The module is reentrant. That is, if the NLM is loaded twice, the actual code in the server's memory is reused.

0x0002 MULTIPLE:

The module can be loaded more than once by a LOAD console command.

0x0004 SYNCHRONIZE:

This option causes the load process to go to sleep until the NLM calls SynchronizeStart. This prevents other console commands from being processed (particularly LOAD commands) while the NLM is being loaded.

0x0008 PSEUDOPREEMPTION:

This option enables the OS to force an NLM to relinquish control if the NLM does not do so on its own often enough.

 

The nlmType field contains a number indicating the NLM type:

The nlmParentID field contains the number assigned to the NLM that caused this NLM to be loaded.

The nlmMajorVersion field contains the major version number of the NLM.

The nlmMinorVersion field contains the minor version number of the NLM.

The nlmRevision field contains the revision letter of the NLM.

The nlmYear, nlmMonth, and nlmDay fields contain the year, month, and day that the NLM was created on.

The nlmAllocAvailBytes, nlmAllocFreeCount, and nlmLastGarbCollect field contain garbage collection information. The nlmAllocAvailBytes contains the bytes available for allocation by the NLM. The nlmAllocFreeCount contain the number of bytes freed that can be reclaimed. The nlmLastGarbCollect field contains the last time garbage collection was done for the NLM (expressed in ticks since the server was brought up).

The nlmMessageLanguage field contains the number representing the language that the NLM uses.

The nlmNumberOfReferencedPublics field contains the number of external symbols referenced by the NLM.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(1)		word (Hi-Lo)
	  9	SubFuncCode	(05)		byte

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	PacketBurstInfo			long (Lo-Hi)

Packet Burst Information Structure

	Offset	Content					Type
	  0	BigInvalidSlotCount			Lo-Hi
	  4	BigForgedPacketCount			Lo-Hi
	  8	BigInvalidPacketCount			Lo-Hi
	 12	BigStillTransmittingCount		Lo-Hi
	 16	StillDoingTheLastRequestCount		Lo-Hi
	 20	InvalidControlRequestCount		Lo-Hi
	 24	ControlInvalidMessageNumberCount	Lo-Hi
	 28	ControlBeingTornDownCount		Lo-Hi
	 32	BigRepeatTheFileReadCount		Lo-Hi
	 36	BigSendExtraCCCount			Lo-Hi
	 40	BigReturnAbortMessageCount		Lo-Hi
	 44	BigReadInvalidMessageNumberCount	Lo-Hi
	 48	BigReadDoItOverCount			Lo-Hi
	 52	BigReadBeingTornDownCount		Lo-Hi
	 56	PreviousControlPacketCount		Lo-Hi
	 60	SendHoldOffMessageCount			Lo-Hi
	 64	BigReadNoDataAvailableCount		Lo-Hi 
	 68	BigReadTryingToReadTooMuchCount		Lo-Hi
	 72	AsyncReadErrorCount			Lo-Hi
	 76	BigReadPhysicalReadErrorCount		Lo-Hi
	 80	ControlBadACKFragmentListCount		Lo-Hi
	 84	ControlNoDataReadCount			Lo-Hi
	 88	WriteDuplicateRequestCount		Lo-Hi
	 92	ShouldntBeACKingHereCount		Lo-Hi
	 96	WriteInconsistentPacketLengthsCount	Lo-Hi
	100	FirstPacketIsntAWriteCount		Lo-Hi
	104	WriteTrashedDuplicateRequestCount	Lo-Hi
	108	BigWriteInvalidMessageNumberCount	Lo-Hi
	112	BigWriteBeingTornDownCount		Lo-Hi
	116	BigWriteBeingAbortedCount		Lo-Hi
	120	ZeroACKFragmentCountCount		Lo-Hi
	124	WriteCurrentlyTransmittingCount		Lo-Hi
	128	TryingToWriteTooMuchCount		Lo-Hi
	132	WriteOutOfMemoryForControlNodesCount	Lo-Hi
	136	WriteDidntNeedThisFragmentCount		Lo-Hi
	140	WriteTooManyBuffersCheckedOutCount	Lo-Hi
	144	WriteTimeOutCount			Lo-Hi
	148	WriteGotAnACKCount			Lo-Hi
	152	WriteGotAnACKCount1			Lo-Hi
	156	PollerAbortedTheConnectionCount		Lo-Hi
	160	MaybeHadOutOfOrderWritesCount		Lo-Hi
	164	HadAnOutOfOrderWriteCount		Lo-Hi
	168	MovedTheACKBitDownCount			Lo-Hi
	172	BumpedOutOfOrderWriteCount		Lo-Hi
	176	PollerRemovedOldOutOfOrderCount		Lo-Hi
	180	WriteDidntNeedButRequestedACKCount	Lo-Hi
	184	WriteTrashedPacketCount			Lo-Hi
	188	TooManyACKFragmentsCount		Lo-Hi
	192	SavedAnOutOfOrderPacketCount		Lo-Hi
	196	ConnectionBeingAbortedCount		Lo-Hi

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length

Remarks

This NCP returns packet burst information.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The packetBurstInfo parameter contains a PacketBurstInformation structure. Fields in this structure will be explained in a later version of this NCP document.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(04)		byte
	 10	ConnectionNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16+	UserInformation			structure
	 yy+	UserNameLen			byte
	 zz++	UserNameString			byte[]

NetWare User Information Structure

	Offset	Content				Type
	0	connectionNumber		long (Lo-Hi)
 	4	useCount			long (Lo-Hi)
 	8	connectionServiceType		byte
 	9	loginTime			byte[7]
	16	status				long (Lo-Hi)
	20	expirationTime			long (Lo-Hi)
	24	objectType			long (Lo-Hi)
	28	transactionFlag			byte
	29	logicalLockThreshold		byte
	30	recordLockThreshold		byte
	31	fileWriteFlags			byte
	32	fileWriteState			byte
	33	filler				byte
	34	fileLockCount			word (Lo-Hi)
	36	recordLockCount			word (Lo-Hi)
	38	totalBytesRead			byte[6]
	44	totalBytesWritten		byte[6]
	50	totalRequests			long (Lo-Hi)
	54	heldRequests			long (Lo-Hi)
	58	heldBytesRead			byte[6]
	64	heldBytesWritten		byte[6]

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Connection Number

Remarks

This NCP returns user information for a given connection.

The connectionNumber parameter in the request format specifies the connection number that you want user information for.

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The userInfo parameter contains a UserInformation structure for the connection. This structure is defined below.

The userNameLen parameter contains the length of the username field.

The username parameter contains the name of the user.

UserInformation structure:

The connectionNumber field contains the connection number of the user.

The useCount field contains 1 if the connection is in use, or 0 if the connection is not in use.

The connectionServiceType field contains the connection type. Connection types are defined as follows:

The loginTime field contains the time that the user logged in.

The status field contains the status of the connection. These are defined as follows:

The expirationTime field contains the time before the authentication expires (in ticks). If this value is 0, there is no expiration time.

The objectType field contains the type of the user.

The transactionFlag field contains transaction tracking information

The logicalLockThreshold field contains the maximum number of logical locks the user can have.

The recordLockThreshold field contains maximum number of record locks the user can have.

The fileWriteFlags field contains a flag indicating the writing status as follows:

The fileWriteState field indicates the writing status:

The filler field is unused.

The fileLockCount field contains the number of files the user has locked.

The recordLockCount field contains the number of records the user has locked.

The totalBytesRead field contains the number of bytes the user has read (48-bit value).

The totalBytesWritten field contains the number of bytes the user has written (48-bit value).

The totalRequests field contains the number of requests the user has sent.

The heldRequests field contains the number of requests held for accounting purposes.

The heldBytesRead field contains the number of bytes the user has read that have a hold on them for accounting purposes.

The heldBytesWritten field contains the number of bytes the user has written that have a hold on them for accounting purposes.

v2.x	v3.x	v4.x	v5.x
		•	•

Request Format

	Offset	Content				Type
	(request header)
	  6	FunctionCode	(123)		byte
	  7	SubFuncStrucLen	(5)		word (Hi-Lo)
	  9	SubFuncCode	(09)		byte
	 10	StartItemNumber			long (Lo-Hi)

Reply Format

	Offset	Content				Type
	(reply header)
	  8	CurrentServerTime		long (Lo-Hi)
	 12	VConsoleVersion			byte
	 13	VConsoleRevision		byte
	 14	reserved			word (Lo-Hi)
	 16	TotalLFSCounters		long (Lo-Hi)
	 20	CurrentLFSCounters		long (Lo-Hi)
	 24+	LFSCounters			long[] (Lo-Hi)

LFS Counters

	Description			Item Number
	CreateDirectory			0
	DeleteDirectory			1
	MapPathToDirectoryNumber 	2
	EraseFile			3
	ModifyDirectoryEntry		4
	RenameEntry			5
	GetAccessRights			6
	GetAccessRightsFromIDs		7
	MapDirectoryNumberToPath	8
	GetEntryFromPathStringBa	9
	GetOtherNameSpaceEntry		10
	DirectorySearch			11
	GetExtendedDirectoryInfo	12
	GetParentDirectoryNumber	13
	AddTrusteeRights		14
	ScanTrusteeRights		15
	DeleteTrusteeRights		16
	PurgeTrustee			17
	FindNextTrusteeReference	18
	ScanUserRestrictionNodes	19
	AddUserRestriction		20
	DeleteUserRestriction		21
	ReturnDirectorySpaceRest	22
	GetActualAvailableDiskSp	23
	CountOwnedFilesAndDirect	24
	ScanDeletedFiles		25
	SalvageDeletedFile		26
	PurgeDeletedFile		27
	OpenFile			28
	CreateFile			29
	CreateAndOpenFile		30
	MigrateFile			31
	DeMigrateFile			32
	MigratedFileInformation		33
	VolumeMigrationInformation	34
	ReadMigratedFileData		35
	ReadFile			36
	WriteFile			37
	ASyncStartReadFile		38
	ASyncDoReadFile			39
	ASyncStartWriteFile		40
	ASyncDoWriteFile		41
	ASyncCheckWriteThrough		42
	NewGetVolumeInfo		43
	MapPathToDirectoryNumberOrPhantom 44
	StationHasAccessRightsGrantedBelow 45
	GetDataStreamLengthsFromPathStringBase 46
	CheckAndGetDirectoryEntry	47
	GetDeletedEntry			48
	GetOriginalNameSpace		49
	GetActualFileSize		50
	VerifyNameSpaceNumber		51
	VerifyDataStreamNumber		52
	CheckVolumeNumber		53
	GetFileSize			54
	ReadFileNoCheck			55
	SetFileTimeAndDateStamp		56
	GetFileHoles			57
	GetHandleInfoData		58
	CloseFile			59
	CommitFile			60
	GetDirectoryEntry		61
	CreateDataMigratedFileEntry	62
	RenameNameSpaceEntry		63
	CancelFileLockWait		64
	CheckAndSetSingleFileLock	65
	ReleaseSingleFileLock		66
	EnumerateFileLocks		67
	CheckAndSetFileLocks		68
	BackoutFileLocks		69
	UnenumerateFileLocks		70
	ReleaseFile			71
	CheckAndSetSingleRecordLock	72
	ReleaseSingleRecordLock		73
	EnumerateRecordLocks		74
	CheckAndSetRecordLocks		75
	BackoutRecordLocks		76
	UnenumerateRecordLocks		77
	ReleaseRecordLocks		78
	SetVolumeFlags			79
	ClearVolumeFlags		80
	GetOriginalInfo			81
	CreateMigratedDir		82
	F3OpenCreate			83
	F3InitFileSearch		84
	F3ContinueFileSearch		85
	F3RenameFile			86
	F3ScanForTrustees		87
	F3ObtainFileInfo		88
	F3ModifyInfo			89
	F3EraseFile			90
	F3SetDirHandle			91
	F3AddTrustees			92
	F3DeleteTrustees		93
	F3AllocDirHandle		94
	F3ScanSalvagedFiles		95
	F3RecoverSalvagedFiles		96
	F3PurgeSalvageableFile		97
	F3GetNSSpecificInfo98		98
	F3ModifyNSSpecificInfo		99
	F3SearchSet			100
	F3GetDirBase			101
	F3QueryNameSpaceInfo		102
	F3GetNameSpaceList		103
	F3GetHugeInfo			104
	F3SetHugeInfo			105
	F3GetFullPathString		106
	F3GetEffectiveDirectoryRights	107
	ParseTree			108

Completion Code

	0	0x00	Successful
	126	0x7E	Invalid Length
	255	0xFF	Failure or Invalid Start Item Number

Remarks

This NCP returns information about the number of times various code paths have been taken in the NetWare OS.

The startItemNumber parameter in the Request Format specifies the number of the counter to start with. (This parameter is included for the future, when there may be more counters than can be retrieved by one call to this NCP.)

The following reply format parameters are defined:

The currentServerTime parameter contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this parameter reaches 0xFFFFFFFF, it wraps to zero.

The VConsoleVersion parameter contains the console version number. The VConsoleVersion and VConsoleRevision parameters track packet format. The VConsoleRevision parameter contains the console version revision number.

The reserved parameter is reserved for future use.

The totalLFSCounters parameter contains the total number of LFS counters.

The currentLFSCounters parameter contains the number of LFS counters returned by this NCP.

The LFScounters parameter contains the first LFS counter. This counter is followed by others.