RPC Services NCPs

RPC Load an NLM 0x2222 131 01

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(see below)	word (Hi-Lo)
	9	SubFuncCode	(01)		byte
	10	NLMLoadOptions	(see below)	long
	14	reserved	(0)		long[3]
	26	reservedFlags	{0}		byte[4]
	30	PathAndName	(see below)	byte[]

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long[4]

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP loads a selected NLM on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, and be at least supervisor equivalent.

RPCccode 0 Successful completion of the request RPC

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the PathAndName (ASCIIZ) including the terminating null.

NLMLoadOptions

Refer to NLM documentation under NLM load options (bit definitions).

PathAndName

ASCIIZ path and file name to load. FORMAT: {volume name:}{path\...}file name\0

RPC Unload an NLM 0x2222 131 02

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(see below)	word (Hi-Lo)
	9	SubFuncCode	(02)		byte
	10	reserved	(0)		long[4]
	26	reservedFlags	{0}		byte[4]
	30	NLMName	(see below)		byte[]

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP unloads a selected NLM on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, and be at least equivalent to supervisor.

RPCccode
	0	Successful completion of the request RPC
	158	Bad File Name or No File Name given

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the NLMName (ASCIIZ) including the terminating null.

PathAndName

ASCIIZ NLM module name to unload. FORMAT: file name\0

RPC Mount Volume 0x2222 131 03

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(see below)	word (Hi-Lo)
	9	SubFuncCode	(03)		byte
	10	reserved	(0)		long[4]
	26	reservedFlags	{0}		byte[4]
	30	VolumeName	(see below)	ASCIIZ

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long[4]
	28	VolumeNumber	(variable)	long

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP mounts a volume on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, and be at least supervisor equivalent.

RPCccode
	0	0x00	Successful completion of the request RPC
	x	xx	Invalid Volume Name
	x	xx	Volume Already Mounted

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the VolumeName (ASCIIZ) including the terminating null.

VolumeName

Volume Name (in ASCIIZ format) to be mounted. FORMAT: volume name\0

RPC Dismount Volume 0x2222 131 04

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(21)		word (Hi-Lo)
	9	SubFuncCode	(04)		byte
	10	reserved	(0)		long[4]
	26	reservedFlags	{0}		byte[4]
	30	VolumeName	(see below)	ASCIIZ

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP dismounts a volume on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, and be at least equivalent to supervisor.

RPCccode
	0	Successful completion of the request RPC
	xx	Invalid Volume Name

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the VolumeName (ASCIIZ) including the terminating null.

VolumeName

Volume Name (in ASCIIZ format) to be mounted. FORMAT: volume name\0

RPC Add Name Space To Volume 0x2222 131 05

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(21)		word (Hi-Lo)
	9	SubFuncCode	(05)		byte
	10	reserved	(0)		long[4]
	26	reservedFlags	{0}		byte[4]
	30	AddNameSpaceAndVol		(see below)	ASCIIZ

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long[4]

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP adds a specified name space to a mounted volume on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, and be at least equivalent to supervisor.

RPCccode
	0	Successful completion of the request RPC

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the AddNameSpaceAndVol (ASCIIZ) including the terminating null.

Add Name Space and Vol

AddNameSpaceAndVol string (in ASCIIZ form) to add the name space to a selected volume name. FORMAT: "NameSpaceName {TO} {VOLUME} VolumeName\0"

NOTE: The format just mentioned must be followed exactly or the request will fail. The name space name should be followed by a space and then the volume name (along with the optional "TO VOLUME" keywords if desired). Also note that the volume name MUST NOT have a colon appended to it.

NameSpaceName Format:

Name	Numeric Value
DOS	0
MAC	1
NFS	2
FTAM	3
OS/2	4

NOTE: In NetWare 4.11 or greater, the OS/2 name space (OS2.NAM) has been replaced with the LONG name space (LONG.NAM).

RPC Set Set Command Value 0x2222 131 06

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(21)		word (Hi-Lo)
	9	SubFuncCode	(06)		byte
	10	typeFlag	(see below)	long
	14	Value		(see below)	long
	18	reserved	(0)		long[2]
	26	reservedFlags	{0}		byte[4]
	30	SetCmdName	(see below)	ASCIIZ
	xx	{optional string} (see typeFlag) ASCIIZ

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long[4]

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP changes the current value of a set command on the server. The client connection requesting this function must have logged in to the server, be permanently authenticated, be at least supervisor equivalent.

RPCccode

	0	Successful completion of the request RPC

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the SetCmdName including the terminating null. If typeFlag is zero, then the optional string size including the null must be included in the SubFuncStrucLen field.

typeFlag

If zero, then the optional string, which follows the SetCmdName, is the new value of the set command. If one, the the Value field contains the new value of the set command.

Value

New value of the set command parameter (if typeFlag is equal to one).

Set Cmd Name

Set parameter command name in ASCIIZ format.

{optional string}

If typeFlag is zero, this string used for the new set command parameter value. The set command parameter types (SP_TYPE_STRING & SP_TYPE_TIME_OFFSET) require a string instead of a numerical value.

RPC Execute NCF File 0x2222 131 07

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

• •

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(see below)	word (Hi-Lo)
	9	SubFuncCode	(07)		byte
	10	reserved	(0)		long[4]
	26	reservedFlags	{0}		byte[4]
	30	PathAndName	(see below)	byte[]

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	reserved	(0)		long[4]

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP executes a selected NCF file on the server.The client connection requesting this function must have logged in to the server, be permanently authenticated, be at least supervisor equivalent.

RPCccode 0 Successful completion of the request RPC 158 Bad File Name or No File Name given

SubFuncStrucLen

The value in this parameter will be 21 plus the size of the PathAndName (ASCIIZ) including the terminating null.

PathAndName

ASCIIZ path and file name to execute. FORMAT:

{volume name:}{path\...}file name\0

XML RPC 0x2222 131 64

v2.x v3.x v4.x v5.x v6.x Linux

•

Request

	Offset	Content				Type
	(request header)
	6	FunctionCode	(131)		byte
	7	SubFuncStrucLen	(see below)	word (Hi-Lo)
	9	SubFuncCode	(64)		byte
	10	xmlPolicyVersion (see below)	long
	14	xmlPolicyLength (see below)	word
	16	xmlPolicyContent (see below)	byte[]

Reply

	Offset	Content				Type
	(reply header)
	8	RPCccode	(see below)	long
	12	xmlContentVersion		long
	16	xmlContentLength		word
	18	xmlContent			byte[]

Completion Code

	0	0x00	Successful
	251	0xFB	Invalid Subfunction Request

Remarks

This NCP will invoke the xml rpc handler to perform various NCP server management functions.

RPCccode 0 Successful completion of the request RPC xx XML RPC failure code

SubFuncStrucLen: The value in this parameter will be 11 plus xmlPolicyLength.

xmlPolicyVersion: Must be set to one.

xmlPolicyLength: Length of the xmlPolicyContent data.

xmlPolicyContent: XML RPC Request data (must be in UTF8).

xmlContentVersion: Must be set to one.

xmlContentLength: Length of the xmlContent data.

xmlContent: XML RPC Reply data (data is in UTF8).