NMS V5 library function summary

This topic summarizes NMS V5 library functions according to task. All functions except NMS_V5PhSendData are synchronous.

Initializing and exiting the NMS V5 library functions

Use the following functions to initialize and exit the NMS V5 library and to set trace levels for the library:

Function	Description
NMS_V5Initialize	Loads and initializes the NMS V5 library.
NMS_V5SetTrace	Configures tracing for the NMS V5 library.
NMS_V5Exit	Performs an internal NMS V5 library clean-up procedure and exits the library.

Creating and destroying interfaces functions

Use the following functions to create and destroy primary and standby variant physical layer interfaces, and to switch from primary interfaces to standby variant interfaces:

Function	Description
NMS_V5ProvisionInterface	Configures (provisions) the HDLC channels for the specified interface.
NMS_V5ProvisionStandByVariant	Configures the HDLC channels and E1 links for an active variant on the specified interface.
NMS_V5DestroyInterface	Destroys all connections for HDLC instances associated with a specified interface.
NMS_V5DestroyStandByVariant	Destroys a provisioned standby variant on the specified interface.
NMS_V5SwitchOverVariantData	Switches the interface to a specified standby variant.
NMS_V5AddE1	Adds an E1 link associated with voice channels to a provisioned active variant on a specified interface.
NMS_V5DeleteE1	Deletes an E1 link from an active variant of a provisioned interface.
NMS_V5AddChannel	Adds an HDLC channel (usually associated with an ISDN data channel) to a provisioned active variant on a specified interface.
NMS_V5DeleteChannel	Removes an HDLC channel from a provisioned active variant on a specified interface.

Controlling interfaces functions

Use the following functions to control physical layer interfaces with the NMS V5 library:

Function	Description
NMS_V5StartInterface	Starts the physical layer (HDLC channels) of the provisioned interface.
NMS_V5StopInterface	Stops the physical layer of the provisioned interface.
NMS_V5PhSendData	Sends a LAPV frame to a specified HDLC channel (asynchronous).
NMS_V5SendSA7Bit	Sets the value of the SA7 E1 framing bit to 0 or 1.

Retrieving and resetting E1 link and channel information functions

Use the following functions to retrieve and reset link status information and channel statistics:

Function	Description
NMS_V5GetE1Status	Retrieves E1 link status information for a specified E1 link.
NMS_V5ResetE1Status	Resets E1 link status information for a specified E1 link.
NMS_V5GetChannelStatistics	Retrieves HDLC channel statistics for a specified HDLC channel on an active provisioned interface.
NMS_V5ResetChannelStatistics	Resets the HDLC channel statistics collected for a specified HDLC channel provisioned on the active interface variant.