WAN Manager SPI Programming Guide Abstract This guide describes the Subsystem Programmatic Interface (SPI) provided by the wide area network (WAN) manager. Product Version G06 and H01 Supported Release Version Updates (RVUs) This publication supports G06.13 and all subsequent G-series RVUs and H06.03 and all subsequent H-series RVUs until otherwise indicated by its replacement publication.
Document History Part Number Product Version 540013-001 G06 and H01 Published July 2005
WAN Manager SPI Programming Guide Glossary Index What’s New in This Manual v Manual Information v New and Changed Information Figures Tables v About This Manual vii Who Should Read This Guide vii How This Guide Is Organized vii Related Manuals viii Notation Conventions viii Abbreviations xiii 1. Introduction Data Definition 1-2 Objects Controlled by the WAN Manager 1-2 WAN Manager Management Functions 1-3 2.
5. WAN Manager Commands and Responses Contents 5.
. WAN Manager Commands and Responses (continued) Contents 5.
5. WAN Manager Commands and Responses (continued) Contents 5. WAN Manager Commands and Responses (continued) VERSION SUBSYS 5-90 Glossary Index Figures Figure 1-1. Figure 3-1. Communication Between the Management Application and WAN Manager 1-1 WAN Manager Object Hierarchy 3-4 Tables Table i. Table 3-1. Table 3-2. Table 3-3. Table 3-4. Table 4-1. Table 4-2. Table 4-3.
What’s New in This Manual Manual Information WAN Manager SPI Programming Guide Abstract This guide describes the Subsystem Programmatic Interface (SPI) provided by the wide area network (WAN) manager. Product Version G06 and H01 Supported Release Version Updates (RVUs) This publication supports G06.13 and all subsequent G-series RVUs and H06.03 and all subsequent H-series RVUs until otherwise indicated by its replacement publication.
What’s New in This Manual New and Changed Information WAN Manager SPI Programming Guide—540013-001 vi
About This Manual The WAN Manager SPI Programming Guide describes the Subsystem Programmatic Interface (SPI) provided by the WAN manager. The WAN manager provides an SPI interface for management applications to obtain information from and to send a command to control the WAN subsystem.
Related Manuals About This Manual Related Manuals Table i describes the SPI and WAN manuals that an application programmer might find useful: Table i. Related Manuals Manual Description SPI Common Extensions Manual Describes an extended SPI subsystem management interface that extends the basic SPI protocol described in the SPI Programming Manual. SPI Programming Manual Describes common extensions to the SPI that are used by many HP NonStop Kernel subsystems.
General Syntax Notation About This Manual lowercase italic letters. Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required. For example: file-name computer type. Computer type letters within text indicate C and Open System Services (OSS) keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. For example: myfile.c italic computer type.
General Syntax Notation About This Manual An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char…" Punctuation. Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown. For example: error := NEXTFILENAME ( file-name ) ; LISTOPENS SU $process-name.
Notation for Messages About This Manual !o:i. In procedure calls, the !o:i notation follows an output buffer parameter that has a corresponding input parameter specifying the maximum length of the output buffer in bytes. For example: error := FILE_GETINFO_ ( filenum , [ filename:maxlen ] ) ; !i !o:i Notation for Messages This list summarizes the notation conventions for the presentation of displayed messages in this guide. Bold Text. Bold text in an example indicates user input typed at the terminal.
Notation for Management Programming Interfaces About This Manual { } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines.
Abbreviations About This Manual Abbreviations ATM. Asynchronous Transfer Mode ATM3SA. ATM 3 ServerNet adapter CCSA. Common Communication ServerNet adapter ConMgr process. concentrator manager process CRU. customer-replaceable unit DIH. driver interrupt handler DSM. Distributed Systems Management E4SA. Ethernet 4 ServerNet adapter EMS. Event Management Service FCSA. Fibre Channel ServerNet adapter FESA. Fast Ethernet ServerNet adapter GESA. Gigabit Ethernet ServerNet adapter G4SA.
Abbreviations About This Manual PIF. physical interface POST. power-on self-test PVC. permanent virtual circuit QIO. Queued Input/Output SAC. ServerNet addressable controller SAN. system area network SCF. Subsystem Control Facility SCP. Subsystem Control Point SEB. ServerNet expansion board SLSA. ServerNet LAN Systems Access SMB. serial maintenance bus SNMP. Simple Network Management Protocol SNMP TMUX. Simple Network Management Protocol Trap Multiplexer SP. service processor SWAN.
1 Introduction SPI, a central component of the Distributed System Management (DSM) architecture, is the path that management applications and subsystems use to exchange command-response messages and event messages. Communication between a management application and a subsystem follows the standard HP NonStop requesterserver model, with the management application in the role of requester and the subsystem manager process in the role of server.
Data Definition Introduction A token consists of a token code (TKN) and a token value (VAL). A token code in turn consists of a token type (TYP) and a token number (TNM). A token type consists of a token data type (TDT) and a token length (TLN). The token data type is the fundamental data type of the token's value. (For example, ZSPI-TDT-INT signifies a 16-bit signed integer value.) For more information on tokens, see the SPI Programming Manual.
WAN Manager Management Functions Introduction WAN Manager Management Functions A WAN manager management application can perform these functions: • • • • • • • • • Abort a process Add new objects to the WAN process Alter the attribute settings of an object Delete an object definition from the WAN process Obtain attribute values of the process or objects under the WAN subsystem Obtain lists of the objects known to the subsystem Obtain status information about the process or object under the WAN subsystem
Introduction WAN Manager Management Functions WAN Manager SPI Programming Guide—540013-001 1 -4
2 Communicating With the WAN Manager Process This section describes the processing of SPI commands and responses of the WAN subsystem through the WAN manager process ($ZZWAN). Using SPI for Sending Commands and Processing Responses The management application program uses SPI procedures to send a command. For more information, see the SPI Programming Manual. Sending a Command Message To send an SPI command: 1. Open the internal SPI module of the WAN manager using the FILE_OPEN_ call. 2.
Communicating With the WAN Manager Process Sending a Command Message header-type is the value of ZSPI-VAL-CMDHDR, which specifies the type of SPI buffer. This value is always zero. command is the value of ZSPI-TKN-COMMAND. object-type is the value of ZSPI-TKN-OBJECT-TYPE. max-resp is the value of ZSPI-TKN-MAXRESP. server-version is the value of ZSPI-TKN-SERVER-VERSION. checksum is the value of ZSPI-TKN-CHECKSUM. max-field-version is the value of ZSPI-TKN-MAX-FIELD-VERSION. 4.
Communicating With the WAN Manager Process Sending a Command Message Example Consider the example of a management application trying to start an adapter. At the SCF prompt, enter the command, START ADAPTER $ZZWAN.#S11, where $ZZWAN.#S11, is the object name of the adapter. The internal SPI module of the WAN manager (#ZSPI) receives the SPI command. 1. Open the #ZSPI internal module of the WAN manager by calling the FILE_OPEN_ procedure: char *filename = "$ZZWAN.
Communicating With the WAN Manager Process Sending a Command Message b. Define the SPI token structure (spi_token) and a temporary command buffer (spi_cmd): typedef struct { unsigned long tkn_name; unsigned char tkn_value[200]; short tkn_length; short tkn_type; } spi_token; spi_token spi_cmd[50]; c. Add all the tokens required for the SPI procedure SSINIT and initialize the SPI buffer: spi_cmd[0].tkn_name = ZCOM_CMD_START; spi_cmd[1].
Communicating With the WAN Manager Process Processing a Response Message 5. After the tokens are inserted into the SPI command buffer: a. Call the SPI procedure SSGETTKN to get the used buffer length: short usedlen; if (SSGETTKN(spi_buffer, ZSPI_TKN_USEDLEN, (char *) &usedlen)) { return FAILURE; } b.
Communicating With the WAN Manager Process Processing a Response Message 4. Reset the buffer using ZSPI_TKN_RESET_BUFFER, which performs resetting operations on the SPI response buffer received to prepare it for scanning. This operation clears the last-error information, resets the maximum buffer length, and resets the current position to the beginning of the buffer. For more information, see the SPI Programming Manual.
3 WAN Manager SPI Commands This section describes the SPI commands supported by the WAN manager that are prefixed with ZWAN-.
WAN Manager SPI Commands WAN Manager Commands by Object Types Table 3-2 lists the commands that can be used in the management programming interfaces to the WAN subsystem. Table 3-2.
WAN Manager SPI Commands WAN Manager Commands by Object Types Table 3-2.
WAN Manager Object Hierarchy WAN Manager SPI Commands WAN Manager Object Hierarchy Figure 3-1 illustrates the WAN subsystem objects and their hierarchy. For more information about the WAN objects, see the WAN Subsystem Configuration and Management Manual. Figure 3-1. WAN Manager Object Hierarchy $ZZWAN SUBSYS DEVICE PROFILE ADAPTER PROCESS SERVER TASK PATH VST0301.
WAN Manager Object Types WAN Manager SPI Commands WAN Manager Object Types The WAN manager object type values represent specific object types. This value is assigned to ZSPI-TKN-OBJECT-TYPE when the command message header is initialized with the SPI procedure SSINIT. Table 3-3 summarizes the WAN manager object types. Table 3-3.
WAN Manager Command Names WAN Manager SPI Commands Table 3-4. WAN Manager Command Names (page 2 of 2) Command Name Function ZCOM-CMDLISTOBJECTS Returns the name and type of all or a subset of the objects created by the WAN manager. The SCF command is NAMES. ZCOM-CMD-LOAD Downloads a file to CLIP FLASH memory. ZCOM-CMD-START Makes an object operational. Any activity associated with this transition, such as implicit link formation, code downloading, and hardware resets can still occur.
4 Commands and Response Tokens This section describes the tokens for commands and responses supported by the WAN manager. The header tokens in the command buffer reappear in the response buffer. Other than header tokens, the command and response buffers have different body tokens. The tokens supplied by the WAN manager are prefixed with ZWAN-. In addition to the ZWAN tokens, the WAN manager also uses tokens prefixed with ZSPI, ZCOM, ZCMK, and so on.
Body Tokens Commands and Response Tokens Body Tokens Table 4-2 lists some command body tokens in the SPI command buffer. For a detailed list of tokens for each WAN manager command, see Section 5, WAN Manager Commands and Responses. Table 4-2.
Commands and Response Tokens Description of Header Tokens ZSPI-TKN-COMMAND contains the command number. Its value is in the format ZCOM-CMD-command and is specified in the call to SSINIT (for example, ZCOM-CMD-START). ZSPI-TKN-LASTERR records the last nonzero status code returned by an SPI procedure when processing the buffer. This value is set by the procedure that detects the error and can be retrieved by calling the SSGET procedure.
Commands and Response Tokens Description of Body Tokens ZSPI-TKN-OBJECT-TYPE specifies the object-type number of the WAN manager object. The value of this token format is ZCOM-OBJ-object-type and is specified in the call to SSINIT. If not specified, it defaults to ZSPI-VAL-NULL-OBJECT-TYPE. ZSPI-TKN-SERVER-VERSION specifies the server version of the WAN manager (WANMAN) process. This token is provided only by subsystems or other programs that act as a server.
Description of Body Tokens Commands and Response Tokens ZCOM-TKN-MANAGER contains the name of the subsystem manager. This token is not required in the command buffer, but allowed. More than one occurrence of this token is not allowed and results in a ZCOM-ERR-TKN-DUP error. Its value for WAN manager is $ZZWAN. ZSPI-TKN-ALLOW-TYPE indicates how to proceed when the WAN manager encounters an error or warning on an object.
Commands and Response Tokens Description of Body Tokens ZSPI-TKN-CONTEXT acts as a response continuance indicator. If a response cannot fit into the SPI response buffer, this token is present in the curtailed response. This token is also required in the next command to retrieve the remaining response information. ZSPI-TKN-DATALIST and ZSPI-TKN-ENDLIST ZSPI-TKN-DATALIST indicates the beginning of a data list. One response record is contained in each data list.
5 WAN Manager Commands and Responses This section describes WAN manager commands and relevant tokens. Some tokens whose values are predetermined and do not vary with the commands are not listed. These tokens (for example, ZSPI-TKN-SSID) are explained in Section 4, Commands and Response Tokens. The tokens ZSPI-TKN-COMMAND, ZSPI-TKN-OBJECT-TYPE, and ZCOM-TKN-OBJNAME are all required (!r) command buffer tokens apart from the header tokens.
WAN Manager Commands and Responses Command Descriptions objects subordinate to that object. For more information, see WAN Manager Object Hierarchy on page 3-4. Command Descriptions Each WAN manager command and its response is described in detail later in this section. The command descriptions appear in the alphabetical order by command name.
WAN Manager Commands and Responses • • ABORT Command TRACE Command on page 5-88 VERSION Command on page 5-89 Using Wild-Card Characters Wild-card characters allow several objects of the same object type to be indicated in a command. The asterisk wild-card character (*) designates zero or more characters. For example, an INFO command issued against the adapter object type with * indicated as the object name returns information on all adapter objects.
WAN Manager Commands and Responses ABORT ADAPTER ABORT ADAPTER This command terminates the operation of all CLIPs on a SWAN concentrator, and places the ADAPTER object in the STOPPED state, which prevents further use of the CLIPs on the SWAN concentrator. The ABORT ADAPTER command does not actually abort the CLIPs (SERVER objects), it only prevents the further use of CLIPs. The devices that are already using the CLIPs are not affected. The ABORT ADAPTER command has this syntax: ABORT ADAPTER $ZZWAN.
WAN Manager Commands and Responses ABORT ADAPTER SCF Example ABORT ADAPTER $ZZWAN.#S*, SEL STARTED, SUB ALL Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SEL-SUMSTATE: ZCOM-CMD-ABORT ZCOM-OBJ-ADAPT $ZZWAN.
WAN Manager Commands and Responses ABORT PATH ABORT PATH This command terminates the operation of a PATH object to a CLIP. The ABORT PATH command places the PATH object in the STOPPED state, which prevents the subsequent use of the Ethernet path. The WAN lines that are using the aborted path will switch to their alternate path, and those configured to use the aborted path as the alternate path will not have an alternate path. The ABORT PATH command has this syntax: ABORT PATH $ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses ABORT PROCESS ABORT PROCESS This command terminates the operation of a ConMgr or a WANBoot process and places the PROCESS object in the STOPPED state. The DEVICE objects use the ConMgr process to download data link control (DLC) tasks to the SWAN concentrator. The DLC tasks cannot be downloaded when the ConMgr process that a device uses is stopped. Otherwise, the device activity is not interrupted by aborting the ConMgr process.
WAN Manager Commands and Responses ABORT SERVER Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#cpu-num | $ZZWAN.#proc-name ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- ABORT SERVER This command terminates the operation of a CLIP and places the SERVER object in the STOPPED state, which prevents further use of the CLIP. The ABORT SERVER command has this syntax: ABORT SERVER $ZZWAN.#conc-name.
ABORT SERVER WAN Manager Commands and Responses ONLY specifies that only the subordinate objects are affected. SCF Example ABORT SERVER $ZZWAN.#S*.1, SUB ALL Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-ABORT ZCOM-OBJ-SERVER $ZZWAN.#conc-name.
ABORT SERVER WAN Manager Commands and Responses Response Buffer Tokens ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses ABORT TASK ABORT TASK This command terminates the operation of the specified data link control (DLC) task by placing the TASK object in the STOPPED state. The task is removed from the CLIP RAM. Tasks that are previously copied to the CLIP FLASH memory are not affected. The ABORT TASK command has this syntax: ABORT TASK $ZZWAN.#conc-name.clip-num.dlc-task conc-name.clip-num.dlc-task conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command.
WAN Manager Commands and Responses ADD Command ADD Command This is a sensitive command that is used to define a WAN subsystem object to the configuration database. The ADD commands are: • • • • • • ADD ADAPTER ADD DEVICE on page 5-15 ADD PATH on page 5-17 ADD PROCESS on page 5-18 ADD PROFILE on page 5-22 ADD SERVER on page 5-23 ADD ADAPTER This command defines a SWAN concentrator to the configuration database. The ADD ADAPTER command has this syntax: ADD ADAPTER $ZZWAN.
WAN Manager Commands and Responses ADD ADAPTER alt-gateway-address indicates the alternate SWAN-side router IP address for Path B. A gateway IP address of 0 (0.0.0.0) indicates that the SWAN concentrator is on the same network as the host. alt-ip-address indicates the IP address assigned to a SUBNET on the alternate TCP/IP process (specified in the ALTTCPIP attribute). alt-subnet-mask-pattern indicates the subnet mask of the SUBNET on the alternate TCP/IP process (specified in the ALTTCPIP attribute).
ADD ADAPTER WAN Manager Commands and Responses located on the label on the rear side of the SWAN concentrator, and is stored in the SWAN concentrator FRU information record (FIR). type-name SYNC and FWCTL are the types supported for the SWAN concentrator. SWAN 2 is the type supported for the SWAN 2 concentrator SCF Example ADD ADAPTER $ZZWAN.#S01, TRACKID "TRA123", & HOSTIP 192.231.60.100, ALTHOSTIP 192.231.70.100, & SUBNETMASK 255.255.255.0, ALTSUBNETMASK 255.255.255.
WAN Manager Commands and Responses ADD DEVICE ADD DEVICE This command defines a data communications subsystem object to the configuration database. You configure one or more DEVICE objects depending on which data communications subsystem you are configuring. The DEVICE objects might access the SWAN concentrator. • • • When defining DEVICE objects that access the SWAN concentrator, the attributes in the ADD DEVICE command that configure the SWAN concentrator are required.
WAN Manager Commands and Responses ADD DEVICE devtype is the NonStop OS registered device type for the DEVICE object. devsubtype is the NonStop OS registered device subtype for the DEVICE object. dlcfilename identifies the type 510 download file that contains the DLC task code that is downloaded and run in the concentrator CLIP to support the DEVICE object. profilename specifies a PROFILE name. existing-devicename is the name of an existing DEVICE object. maxrecsize is supported by each DEVICE object.
ADD PATH WAN Manager Commands and Responses modifiervalue is a string of characters whose syntax is defined by the PROFILE name. SCF Example ADD DEVICE $ZZWAN.#EXP777, PROFILE SLHSNA, CPU 0, ALTCPU 1, & IOPOBJECT $SYSTEM.SYS00.
ADD PROCESS WAN Manager Commands and Responses You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, $ZZWAN.#S01.*, and $ZZWAN.#S01.?.?) to select more than one object matching the pattern. ip-address is a 4-octet (32-bit) numeric value. It is specified in dotted decimal notation, which represents four octets in ASCII, separated by periods (for example, 133.50.85.43). Each octet value is a number in the range 0 through 255.
WAN Manager Commands and Responses ADD PROCESS cpu-num indicates the name of the ConMgr process specifying the processor in which the ConMgr process is to run. You can also use wild cards such as an asterisk (*) or question mark (?) (for example, $ZZWAN.#?). object-filename indicates the file name of the executable object code for the ConMgr process. SCF Examples 1. The syntax for the ConMgr process is: ADD PROCESS $ZZWAN.
WAN Manager Commands and Responses ADD PROCESS cpu-num is the processor number where the primary process normally executes. altcpunum is the processor number where the backup process normally runs. tcpip-name is the name of the preferred TCP/IP process. dumpvol is the location for processor dumps. For example: ADD PROCESS $ZZWAN.#MYWBA, TYPE (0,30), CPU 0, ALTCPU 1, & IOPOBJECT $SYSTEM.sys03.WANBOOT, STARTUP "TCPIP $ZTC1" 3. The syntax for the TFTP server process is: ADD PROCESS $ZZWAN.
WAN Manager Commands and Responses ADD PROCESS For example: ADD PROCESS $ZZWAN.#MYZTA, TYPE (0,48), CPU 0, ALTCPU 1, & IOPOBJECT $SYSTEM.ZTCPIP.TFTPSRV, TCPIP $ZTC1, & STARTUP "$SYSTEM.CSS01" 4. The syntax for the SNMP trap multiplexer process is: ADD PROCESS $ZZWAN.#proc-name, TYPE type, IOPOBJECT object-filename , CPU cpu-num [ , ALTCPU altcpunum ] [ , TCPIP tcpip-name ] proc-name is the name of the SNMP trap multiplexer process. type is the NonStop OS registered device type for the PROCESS object.
WAN Manager Commands and Responses ADD PROFILE Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#cpu-num | $ZZWAN.#proc-name ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- ADD PROFILE This command defines a profile to the configuration database. A profile defines configuration modifiers that are used by the data communications subsystem objects. The PROFILE object is associated with a data communications subsystem object in the ADD DEVICE command.
ADD SERVER WAN Manager Commands and Responses SCF Example ADD PROFILE $ZZWAN.#X25PROF, FILE $SYSTEM.SYS01.PX250061 Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZWAN-TKN-PROFILE-FILE: ZCOM-CMD-ADD ZCOM-OBJ-PROF $ZZWAN.#profilename disc-filename !r Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.
WAN Manager Commands and Responses ALTER Command Response Buffer Tokens ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num ZCOM-TKN-OBJTYPE: ZCOM-OBJ-SERVER ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- ALTER Command The ALTER command enables the user to change the value of one or more static configuration attributes of an existing WAN manager object.
WAN Manager Commands and Responses ALTER ADAPTER conc-name is the user name of the SWAN concentrator. The SWAN concentrator name follows the HP manufacturing naming convention S conc-num, where conc-num indicates the name of the SWAN concentrator (for example, S01). You can also use wild cards such as an asterisk (*) or question mark (?), for example, $ZZWAN.#?. (For information about HP manufacturing naming conventions, see the WAN Subsystem Configuration and Management Manual.
ALTER ADAPTER WAN Manager Commands and Responses subnet-mask-pattern indicates the subnet mask of the SUBNET on the preferred TCP/IP process (specified in the TCP/IP attribute). tcpip-name is the name of the preferred TCP/IP process. configuration-track-id is the six ASCII character track ID found on the concentrator label. The track ID is assigned when the concentrator is manufactured, placed on the label, and stored in the concentrator FRU information record (FIR).
WAN Manager Commands and Responses ALTER DEVICE ALTER DEVICE This command changes the values of a data communications subsystem object. This command changes only the specified attributes of the target object. The ALTER DEVICE command has this syntax: ALTER DEVICE $ZZWAN.
ALTER DEVICE WAN Manager Commands and Responses modifierkeyword and modifiervalue is a keyword defined in profilename that enables a user to configure some product-specific characteristic of the DEVICE object. modifiervalue is a string of characters whose syntax is defined in profilename. path-name indicates which Ethernet path on the SWAN concentrator you prefer the device to use. The possible values are A or B. A indicates the A Ethernet path. B indicates the B Ethernet path. There is no default.
ALTER PATH WAN Manager Commands and Responses ALTER PATH This command changes the IP address of an existing path. The ALTER PATH command has this syntax: ALTER PATH $ZZWAN.#conc-name.clip-num.path-name , IPADDRESS ip-address conc-name.clip-num.path-name conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number in which the path is being altered. path-name is the name of the Ethernet path. The possible values for the path name are A or B.
ALTER PROCESS WAN Manager Commands and Responses ALTER PROCESS This command changes the values of attributes of a ConMgr, an SNMP trap multiplexer, a TFTP server, or a WANBoot process. The ALTER PROCESS command has this syntax: ALTER PROCESS $ZZWAN.
ALTER PROFILE WAN Manager Commands and Responses type and subtype type is the NonStop OS registered device type for the PROCESS object. subtype is the NonStop OS registered device subtype for the PROCESS object. SCF Example ALTER PROCESS $ZZWAN.#ZTXVI, TYPE (0,49), CPU 2, ALTCPU 3, & HOSTIP 192.168.015.077, & IOPOBJECT $SYSTEM.SYS01.
ALTER TASK WAN Manager Commands and Responses modifier-value specifies a string of characters associated with the specified modifier-keyword. SCF Example ALTER PROFILE $ZZWAN.#CP6130, & BSCNONSTOPOFF, BSCSYNCS 3, BSCREADTO 3000, & BSCRETRIES 7, BSCITBSIZE 0, PROFILEID 1 Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZWAN-TKN-MODIFIER: ZCOM-CMD-ALTER ZCOM-OBJ-PROF $ZZWAN.
WAN Manager Commands and Responses ALTER TASK download-filename identifies the NonStop OS-based file where the TASK object code can be found. path-name selects the path to access the SERVER object, which overrides the preferred PATH object specified for conc-name. The possible values for the path name are A or B. A indicates the A Ethernet path. B indicates the B Ethernet path. SCF Example ALTER TASK $ZZWAN.#S01.3.DLC0, PROGRAM $SYSTEM.CSS00.
WAN Manager Commands and Responses DELETE Command DELETE Command This is a sensitive command that is used to remove a WAN subsystem object from the configuration database. The DELETE commands are: • • • • • • DELETE ADAPTER DELETE DEVICE on page 5-37 DELETE PATH on page 5-37 DELETE PROCESS on page 5-38 DELETE PROFILE on page 5-39 DELETE SERVER on page 5-40 DELETE ADAPTER This command removes the definition of a SWAN concentrator. The ADAPTER object must be in the STOPPED state.
DELETE ADAPTER WAN Manager Commands and Responses ONLY specifies that only the subordinate objects are affected. SCF Example DELETE ADAPTER $ZZWAN.#S0?, SUB ALL Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-DELETE ZCOM-OBJ-ADAPT $ZZWAN.
WAN Manager Commands and Responses DELETE ADAPTER Tokens in Response Buffer If the SUB optional parameter is used in the command as SUB ALL or SUB ONLY, then the response buffer contains an error for a DIAG TASK, because the DELETE command is not valid for a DIAG TASK. ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.#conc-name.clip-num.path-name" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PATH ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST ZSPI-TKN-DATALIST: ZSPI-TKN-ERRLIST: ZSPI-TKN-ERROR: Z-SSID TANDEM.WANMGR.
WAN Manager Commands and Responses DELETE DEVICE DELETE DEVICE This command removes the definition of a data communications subsystem object from the configuration database. You must stop the DEVICE object with the STOP DEVICE command before you can delete it. The DELETE DEVICE command has this syntax: DELETE DEVICE $ZZWAN.#devicename devicename is the name of the WAN line without the leading dollar sign ($) or a name template.
DELETE PROCESS WAN Manager Commands and Responses path-name is the name of the Ethernet path. The possible values for the path name are A or B. A indicates the A Ethernet path. B indicates the B Ethernet path. You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, $ZZWAN.#S01.*, and $ZZWAN.#S01.?.?) to select more than one object matching the pattern. SCF Example DELETE PATH $ZZWAN.#S01.1.
WAN Manager Commands and Responses DELETE PROFILE SCF Example DELETE PROCESS $ZZWAN.#4 Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-DELETE ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PROC ZCOM-TKN-OBJNAME: $ZZWAN.#{ cpu-num | proc-name } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#{ cpu-num | proc-name } ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- DELETE PROFILE This command removes a profile from the configuration database.
DELETE SERVER WAN Manager Commands and Responses DELETE SERVER This command removes a CLIP from the configuration database. The DELETE SERVER command has this syntax: DELETE SERVER $ZZWAN.#conc-name.clip-num [ , SUB { ALL | NONE | ONLY } ] conc-name.clip-num conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number in deletion. You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.
WAN Manager Commands and Responses DELETE SERVER Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#profilename ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROF ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST: ZSPI-TKN-DATALIST: ZSPI-TKN-ERRLIST: ZSPI-TKN-ERROR: Z-SSID TANDEM.WANMGR.G06 Z-ERROR (2) <- Command is not valid for a DIAG TASK. ZCOM-TKN-OBJNAME: "$ZZWAN.#conc-name.clip-num.DIAG" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-TASK (24) ZSPI-TKN-ENDLIST: ZCOM-TKN-OBJNAME: "$ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses INFO Command INFO Command INFO is a nonsensitive command that displays static configuration information for a WAN subsystem object. The optional parameter OBEYFORM with the INFO command causes the INFO command to display the information about the object in the form of ADD or ALTER commands, so you can use the information to create the object's configuration.
WAN Manager Commands and Responses INFO ADAPTER TCPIP displays only the preferred TCP/IP process that supports the SWAN concentrator. TRACKID displays only the configuration track ID. TYPE displays only the SWAN concentrator type. OBEYFORM causes the INFO command to display the information about the adapter in the form of ADD ADAPTER commands. You can use the information to create the adapter’s configuration.
WAN Manager Commands and Responses INFO DEVICE Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZWAN-TKN-TRACK-ID: configuration-track-id ZWAN-TKN-TCPIP-NAME: tcpip-name ZWAN-TKN-CONC-TYPE: "SYNC" | "FWCTL" | "SWAN 2" ZWAN-TKN-ALT-TCPIP-NAME: alt-tcpip-name ZWAN-TKN-ESSENTIALCODE: swan-kernel-micode-file-name ZWAN-TKN-SNMPCODE: swan-snmp-agent-micode-file-name ZWAN-TKN-GATEWAY-IP: gateway-address ZWAN-TKN-ALT-GATEWAY-IP: alt-gateway-address ZWAN-TKN-PREFERRED-IP: ip-address ZWAN-TKN-ALTERNATE-IP: alt-ip-addr
INFO DEVICE WAN Manager Commands and Responses DETAIL displays detailed information about the DEVICE object. IOPOBJECT displays only the SWAN concentrator IOPOBJECT. LINE displays only the SWAN concentrator LINE. PATH displays only the SWAN concentrator PATH. PROFILE displays only the PROFILE object. RECSIZE displays only the RECSIZE attribute. TYPE for the INFO DEVICE command, displays only the type and subtype for the DEVICE object.
INFO DEVICE WAN Manager Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZSPI-TKN-SEGLIST: ZCMK-TKN-SEGTYPE: -32763 ZWAN-TKN-IOPOBJECT: "\IDC12.$SYSTEM.SYS00.
INFO PATH WAN Manager Commands and Responses INFO PATH This command returns the static configuration attribute values for a path on a CLIP within a SWAN concentrator. The INFO PATH command has this syntax: INFO PATH $ZZWAN.#conc-name.clip-num.path-name [ , IPADDRESS ] [ , OBEYFORM ] conc-name.clip-num.path-name conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number. path-name is the name of the Ethernet path.
INFO PROCESS WAN Manager Commands and Responses INFO PROCESS This command displays the static configuration attribute values for a ConMgr, an SNMP trap multiplexer, a TFTP server, or a WANBoot process. The INFO PROCESS command has this syntax: INFO PROCESS $ZZWAN.#{ cpu-num | proc-name } [, { IOPOBJECT | OBEYFORM } ] cpu-num is the processor number where the ConMgr object normally executes. You can also use wild cards such as an asterisk (*) or question mark (?) in any combination (for example, $ZZWAN.
WAN Manager Commands and Responses INFO PROFILE Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZWAN-TKN-IOPOBJECT: object-filename ZWAN-TKN-PREFERRED-CPU: cpu-num ZWAN-TKN-ALTERNATE-CPU: alt-cpu-num ZWAN-TKN-DEVTYPE: first parameter of type ZWAN-TKN-DEV-SUBTYPE: second parameter of type ZWAN-TKN-RECSIZE: number <- is the RECSIZE with which the PROCESS is configured. ZCOM-TKN-OBJNAME: $ZZWAN.
INFO PROFILE WAN Manager Commands and Responses SCF Example INFO PROFILE $ZZWAN.#X25PROF Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZSPI-TKN-MANAGER: ZCOM-TKN-OBJNAME: ZWAN-TKN-OBEYFORM: ZCOM-CMD-INFO ZCOM-OBJ-PROF $ZZWAN $ZZWAN.#profilename 1 !o Tokens in Response Buffer ZSPI-TKN-DATALIST: ZWAN-TKN-IOPOBJECT: "\IDC12.$SYSTEM.SYS01.
INFO SERVER WAN Manager Commands and Responses INFO SERVER This command returns the static configuration attribute values for a CLIP. The INFO SERVER command has this syntax: INFO SERVER $ZZWAN.#conc-name.clip-num [ , OBEYFORM ] conc-name.clip-num conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number. You can use wild cards such as an asterisk (*) or question mark (?), which can be used in any combination (for example, $ZZWAN.#*, $ZZWAN.
WAN Manager Commands and Responses INFO SUBSYS INFO SUBSYS This command returns the values for the WAN manager SUBSYS object static configuration attributes. The INFO SUBSYS command has this syntax: INFO SUBSYS [ [ [ [ [ $ZZWAN , IOPOBJECT ] , CONFIGFILE ] , OBEYFORM ] , SUB { ALL | NONE | ONLY } ] , SUBNETLIST ] IOPOBJECT displays only the object file name of the WAN manager process as specified in the PROGRAM attribute in the NonStop Kernel subsystem SCF ADD PROCESS $ZZKRN.#ZZWAN command.
WAN Manager Commands and Responses INFO SUBSYS SCF Example INFO SUBSYS $ZZWAN, SUBNETLIST Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-INFO ZCOM-OBJ-SUBSYS $ZZWAN ZCOM-VAL-SUB-ALL | ZCOM-VAL-SUB-NONE | ZCOM-VAL-SUB-ONLY !o ZWAN-TKN-SUBNET-LIST: number !o ZWAN-TKN-OBEYFORM: 1 !o Tokens in Response Buffer The response buffer tokens depend on whether ZCOM-TKN-SUB was supplied, ZWAN-TKN-SUBNET-LIST was supplied in the command, or both were not supp
WAN Manager Commands and Responses INFO TASK The format of the display of the INFO SUBSYS command is: WAN MANAGER Detailed Info Subsys \IDC12.$ZZWAN ------------------------------------------------------------------------HOSTIP | TCPIP | WBNAME | TFTPNAME | TMUXNAME | NO. OF ADAP| ------------------------------------------------------------------------| | | | | | 192.168.010.
LOAD Command WAN Manager Commands and Responses SCF Example INFO TASK $ZZWAN.#S13.1.DLC0 Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-INFO ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-TASK ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.{ DLC0 | DLC1 | DIAG } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZWAN-TKN-PROGRAM: download-filename ZWAN-TKN-PORT-NUMBER: number ZWAN-TKN-PATH-NAME: path-name ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses NAMES Command NAMES Command This command returns a list of objects subordinate to the object to which the command is issued. The NAMES commands are: • • • • • • • • NAMES ADAPTER NAMES DEVICE on page 5-57 NAMES PATH on page 5-58 NAMES PROCESS on page 5-59 NAMES PROFILE on page 5-60 NAMES SERVER on page 5-61 NAMES SUBSYS on page 5-61 NAMES TASK on page 5-64 NAMES ADAPTER This command displays a list of the names of all configured SWAN concentrators.
NAMES DEVICE WAN Manager Commands and Responses ONLY specifies that only the subordinate objects are affected. SCF Example NAMES ADAPTER $ZZWAN.*, SUB ALL Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-LISTOBJECTS ZCOM-OBJ-ADAPT $ZZWAN.#conc-name ZCOM-VAL-SUB-ALL | ZCOM-VAL-SUB-NONE | ZCOM-VAL-SUB-ONLY Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.
WAN Manager Commands and Responses NAMES PATH device-name is the name of the WAN line without the leading dollar sign ($) sign or a name template. The wild cards can be an asterisk (*), which can be used in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, and so on) to select more than one object matching the pattern. SCF Example NAMES DEVICE $ZZWAN.* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-LISTOBJECTS ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-DEV ZCOM-TKN-OBJNAME: $ZZWAN.
WAN Manager Commands and Responses NAMES PROCESS SCF Example NAMES PATH $ZZWAN.#S13.1.* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-LISTOBJECTS ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PATH ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.{ A | B } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.#S13.1.A" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PATH ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST: ZSPI-TKN-DATALIST: ZCOM-TKN-OBJNAME: "$ZZWAN.#S13.1.
WAN Manager Commands and Responses NAMES PROFILE SCF Example NAMES PROCESS $ZZWAN.* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-LISTOBJECTS ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PROC ZCOM-TKN-OBJNAME: $ZZWAN.{ cpu-name | proc-name } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.{ cpu-name | proc-name }" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- NAMES PROFILE This command displays a list of the configured profiles.
WAN Manager Commands and Responses NAMES SERVER NAMES SERVER This command displays a list of the configured CLIPs. The NAMES SERVER command has this syntax: NAMES SERVER $ZZWAN.#conc-name.clip-num conc-name.clip-num conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number. You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, $ZZWAN.#S*.*, $ZZWAN.#S01.
NAMES SUBSYS WAN Manager Commands and Responses ALL specifies that the named object and the subordinate objects are affected. NONE specifies that the named object is affected but that the subordinate objects are not. NONE is the default. ONLY specifies that only the subordinate objects are affected.
WAN Manager Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-SUBSYS ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST: ZSPI-TKN-DATALIST: ZCOM-TKN-OBJNAME: "$ZZWAN.profile-name" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROF ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST ZSPI-TKN-DATALIST: ZCOM-TKN-OBJNAME: "$ZZWAN.
WAN Manager Commands and Responses NAMES TASK The format of display of the NAMES SUBSYS command is: WANMgr Names SUBSYS $ZZWAN SUBSYS $ZZWAN PROFILE $ZZWAN.#profile-name $ZZWAN.#process-name $ZZWAN.#conc-name $ZZWAN.#clip-name $ZZWAN.#path-name $ZZWAN.#task-name $ZZWAN.#device-name NAMES TASK This command displays a list of the names of all tasks on the SWAN concentrator. The NAMES TASK command has this syntax: NAMES TASK $ZZWAN.#conc-name.clip-num.dlc-task conc-name.clip-num.
WAN Manager Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: "$ZZWAN.#S13.1.DIAG" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-TASK ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST: ZSPI-TKN-DATALIST: ZCOM-TKN-OBJNAME: "$ZZWAN.#S13.1.DLC0" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-TASK ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST: ZSPI-TKN-DATALIST: ZCOM-TKN-OBJNAME: "$ZZWAN.#S13.1.
PRIMARY Command WAN Manager Commands and Responses PRIMARY Command This is a sensitive command that is used to change the preferred processor of the WAN manager process. The WAN manager process must be configured to run as a process pair. PRIMARY SUBSYS This command requests the WAN manager to set its preferred processor to the new processor and to change its processor ownership to the new processor if possible.
WAN Manager Commands and Responses START Command START Command This command initiates the operation of a WAN manager object by setting the object state to STARTED. The START commands are: • • • • • • START ADAPTER START DEVICE on page 5-68 START PATH on page 5-69 START PROCESS on page 5-70 START SERVER on page 5-71 START TASK on page 5-72 START ADAPTER This command places a SWAN concentrator in the STARTED state. You can also use the OSM Service Connection or the TSM Service Application.
START DEVICE WAN Manager Commands and Responses SCF Example START ADAPTER $ZZWAN.#S* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-START ZCOM-OBJ-ADAPT $ZZWAN.#conc-name ZCOM-VAL-SUB-ALL | ZCOM-VAL-SUB-NONE | ZCOM-VAL-SUB-ONLY !o Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.
WAN Manager Commands and Responses START PATH NONE specifies that the named object is affected but that the subordinate objects are not. NONE is the default. SCF Example START DEVICE $ZZWAN.#AMA Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-START ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-DEV ZCOM-TKN-OBJNAME: $ZZWAN.#devicename Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.
START PROCESS WAN Manager Commands and Responses SCF Example START PATH $ZZWAN.#S13.1.* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-START ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PATH ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.{ A | B } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.{ A | B } ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PATH ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- START PROCESS This command places a process in the STARTED state.
START SERVER WAN Manager Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#{ cpu-num ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- | proc-name } START SERVER This command places a CLIP in the STARTED state. You can also use the OSM Service Connection or the TSM Service Application. For more information on using OSM or TSM, refer to the online help within each application.
START TASK WAN Manager Commands and Responses HWSTATUS specifies hardware status information from the SERVER (CLIP) object. This attribute also provides additional information if the command detects a mismatched type on one of the CLIPs. The HWSTATUS attribute is supported on the SWAN 2 concentrator only. SCF Example START SERVER $ZZWAN.#S13.* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-TKN-SUB: ZCOM-CMD-START ZCOM-OBJ-SERVER $ZZWAN.#conc-name.
WAN Manager Commands and Responses STATUS Command You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, $ZZWAN.#S*.*, and $ZZWAN.#S01.1.DLC?) to select more than one object matching the pattern. SCF Example START TASK $ZZWAN.#S13.1.DLC? Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-START ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-TASK ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses STATUS ADAPTER The STATUS ADAPTER command has this syntax: STATUS ADAPTER $ZZWAN.#conc-name [ , SUB { ALL | NONE | ONLY } ] [ , HWSTATUS ] conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. You can use wild cards such as the asterisk (*) to specify all configured ADAPTER objects. SUB { ALL | NONE | ONLY } selects the subordinate objects the command affects. ALL specifies that the named object and the subordinate objects are affected.
WAN Manager Commands and Responses STATUS DEVICE Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STARTED ZWAN-TKN-CLIP-STATUS: status ZWAN-TKN-COMPONENT: 0 ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STARTED ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name ZCOM-TKN-OBJTYPE: ZCOM-OBJ-ADAPT ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- STATUS DEVICE This command displays the current status and configuration information about a data communications subsystem object.
WAN Manager Commands and Responses STATUS PATH STATUS PATH This command displays the current status and configuration information about a path on a CLIP. You can also use the OSM Service Connection or the TSM Service application. For more information on using OSM or TSM, see the online help within each application. The STATUS PATH command has this syntax: STATUS PATH $ZZWAN.#conc-name.clip-num.
STATUS PROCESS WAN Manager Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STOPPED ZWAN-TKN-MEDIA-ADDR FAMILY 1 ADDRESS 8 0 142 3 18 168 0 0 0 0 0 0 0 0 ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STOPPED ZCOM-TKN-OBJNAME: "$ZZWAN.#S15.1.
WAN Manager Commands and Responses STATUS SERVER Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZWAN-TKN-PRIMARY-CPU: 1 ZWAN-TKN-PRIMARY-PIN: 353 ZWAN-TKN-TRACE-STATUS: 0 ZWAN-TKN-IOP-LDEV: 69 ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STARTED ZCOM-TKN-OBJSTATE: ZCOM-VAL-SUMSTATE-STARTED ZCOM-TKN-OBJNAME: "$ZZWAN.#1" ZCOM-TKN-OBJTYPE: ZCOM-OBJ-PROC ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- STATUS SERVER This command displays the current status and configuration information about a CLIP.
WAN Manager Commands and Responses STATUS SERVER ONLY specifies that only the subordinate objects are affected. DETAIL specifies that the display is to include additional detailed information about the object. The DETAIL option provides the VPROC information of the CLIP firmware, status for both paths and the last time the path status changed. HWSTATUS specifies hardware status information from the SERVER object.
WAN Manager Commands and Responses STATUS TASK STATUS TASK This command displays the current status and configuration information about a DLC0 or DLC1 task. You can also use the OSM Service Connection or the TSM Service Application. For more information on using OSM or TSM, see the online help within each application. The STATUS TASK command gets the status of the DLC or DIAG tasks from the CLIP. The STATUS TASK command has this syntax: STATUS TASK $ZZWAN.#conc-name.clip-num.
WAN Manager Commands and Responses STOP Command SCF Example STATUS TASK $ZZWAN.#SWAN21.4.DLC0? Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-STATUS ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-TASK ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name.clip-num.{ DLC0 | DLC1 | DIAG } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJSTATE: ZCOM-ENM-SUMSTATE-STARTED ZWAN-TKN-PATH-NAME: "A" ZWAN-TKN-PORT-NUMBER: 5000 ZWAN-TKN-PROTID: 1 ZWAN-TKN-INTERFACE-TYPE: 0 ZWAN-TKN-PROGRAM: "$SYSTEM.CSS01.
STOP ADAPTER WAN Manager Commands and Responses SERVER objects must first be placed in the STOPPED state, or the STOP ADAPTER command is rejected. The STOP ADAPTER command has this syntax: STOP ADAPTER $ZZWAN.#conc-name [, SUB { ALL | NONE | ONLY }] conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. You can use wild cards such as an asterisk (*), in any combination (for example, $ZZWAN.#* and $ZZWAN.#S*) to select more than one object matching the pattern.
WAN Manager Commands and Responses STOP DEVICE Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.#conc-name ZCOM-TKN-OBJTYPE: ZCOM-OBJ-ADAPT ZSPI-TKN-RETCODE: ZCOM-ERR-OK ZSPI-TKN-ENDLIST:- STOP DEVICE This command stops a data communications subsystem object. The STOP DEVICE command has this syntax: STOP DEVICE $ZZWAN.#devicename devicename is the name of the WAN line without the leading dollar sign ($) or a name template.
WAN Manager Commands and Responses STOP PROCESS The STOP PATH command has this syntax: STOP PATH $ZZWAN.#conc-name.clip-num.path-name conc-name.clip-num.path-name conc-name is the name of the SWAN concentrator as specified in the ADD ADAPTER command. clip-num is the CLIP number to which the PATH is being stopped. path-name is the name of the Ethernet path. The possible values for the path name are A or B. A indicates the A Ethernet path. B indicates the B Ethernet path.
STOP SERVER WAN Manager Commands and Responses proc-name is the name of process other than ConMgr. You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#?, $ZZWAN.#*, and so on). SCF Example STOP PROCESS $ZZWAN.#* Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-STOP ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PROC ZCOM-TKN-OBJNAME: $ZZWAN.#{ cpu-num | proc-name } Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.
STOP TASK WAN Manager Commands and Responses ALL specifies that the named object and the subordinate objects are affected. If SUB ALL is not specified, all the subordinate objects must be stopped before you issue the STOP SERVER command. NONE specifies that the named object is affected but that the subordinate objects are not. NONE is the default. ONLY specifies that only the subordinate objects are affected. SCF Example STOP SERVER $ZZWAN.#S13.
WAN Manager Commands and Responses STOP TASK clip-num is the CLIP number where the TASK object executes. dlc-task is the name of the DLC task running in a WAN port. The possible values are DLC0 or DLC1. DLC0 indicates the task running in WAN port 0. DLC1 indicates the task running in WAN port 1. You can also use wild cards such as an asterisk (*) or question mark (?), in any combination (for example, $ZZWAN.#*, $ZZWAN.#S*, $ZZWAN.#S*.*, and $ZZWAN.#S01.1.
WAN Manager Commands and Responses TRACE Command TRACE Command The TRACE command is a sensitive command that requests the capturing of trace data, or ends tracing.The TRACE command discussed is TRACE PROCESS. TRACE PROCESS This command initiates, modifies, or terminates trace mode on a ConMgr process. Using the TRACE command, you can request capture of target-defined data items, alter trace parameters, and end tracing. TRACE PROCESS $ZZWAN.
VERSION Command WAN Manager Commands and Responses SCF Example TRACE PROCESS $ZZWAN.#0, TO $SYSTEM.ARULPRI.TRACE0, RECSIZE 4000, SELECT ALL Tokens in Command Buffer ZSPI-TKN-COMMAND: ZSPI-TKN-OBJECT-TYPE: ZCOM-TKN-OBJNAME: ZCOM-MAP-TRACE-MODIF: ZCOM-CMD-TRACE ZCOM-OBJ-PROC $ZZWAN.#cpu-num modifiers <- attributes given and explained in Syntax !r Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZCOM-TKN-OBJNAME: $ZZWAN.
WAN Manager Commands and Responses VERSION SUBSYS SCF Example VERSION PROCESS $ZZWAN.#? Tokens in Command Buffer ZSPI-TKN-COMMAND: ZCOM-CMD-GETVERSION ZSPI-TKN-OBJECT-TYPE: ZCOM-OBJ-PROC ZCOM-TKN-OBJNAME: $ZZWAN.#cpu-num Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZSPI-TKN-SERVER-BANNER: (50 ASCII characters - addressable as a STRUCT, bytes, or INT's product number release-date submittal-number ) ZCOM-TKN-OBJNAME: $ZZWAN.
WAN Manager Commands and Responses VERSION SUBSYS Tokens in Response Buffer ZSPI-TKN-DATALIST:* ZSPI-TKN-SEGMENTATION: T <- TRUE ZWAN-TKN-CODE-VERSION: int 32 token code ZWAN-TKN-CAPABILITY-MATRIX: int 32 token code ZSPI-TKN-SERVER-BANNER: WANMgr ( 43 ASCII characters addressable as a STRUCT, bytes, or INT's - product number release-date submittal-number) ZCMK-TKN-PKG-BANNER: COM-KRNL ( 41 ASCII characters addressable as a STRUCT, bytes, or INT's - product number release-date submittal-number) ZCOM-TKN-OB
WAN Manager Commands and Responses WAN Manager SPI Programming Guide—540013-001 5- 92 VERSION SUBSYS
Glossary ASCII. American Standard Code for Information Interchange. A single-byte code set that uses only 7 of the 8 bits in a byte to represent each character. The ASCII code set contains the uppercase and lowercase characters of the U.S. English alphabet, some punctuation symbols, the digits 0 through 9, and some symbols and control characters.
Event Management Service (EMS). Glossary Event Management Service (EMS). A Distributed Systems Management (DSM) product that provides event collection, event logging, and event distribution facilities. EMS provides different event descriptions for interactive and programmatic interfaces, lets an operator or an application select specific event-message data, and allows for flexible distribution of event messages within a system or network. event message.
ServerNet wide area network (SWAN) 2 concentrator. Glossary ServerNet wide area network (SWAN) 2 concentrator. An HP data communications peripheral that provides connectivity to an HP NonStop S-series server. The SWAN 2 concentrator supports both synchronous and asynchronous data over RS-232, RS-449, X.21, and V.35 electrical and physical interfaces. The SWAN 2 concentrator is the next-generation SWAN concentrator and has 12 WAN ports. Simple Network Management Protocol (SNMP).
Trivial File Transfer Protocol (TFTP). Glossary Trivial File Transfer Protocol (TFTP). A protocol defined by Request for Comments (RFC) 1350. TFTP is used as a data link control (DLC) and diagnostic task. TSM. Identifies a client or server software component used to manage or service HP NonStop S-series servers. TSM Service Application. A component of the HP TSM client software.
wild-card character. Glossary wild-card character. A character that stands for any possible character or characters in a search string or in a name applying to multiple objects. In Subsystem Control Facility (SCF) object-name templates, two wild-card characters can appear: ? (question mark) for a single character and * (asterisk) for zero or more consecutive characters. $ZZWAN. The name of the wide area network (WAN) subsystem manager process.
$ZZWAN.
Index A ABORT commands ABORT ADAPTER 5-4 ABORT PATH 5-6 ABORT PROCESS 5-7 ABORT SERVER 5-8 ABORT TASK 5-11 description of 5-3 ADD commands ADD ADAPTER 5-12 ADD DEVICE 5-15 ADD PATH 5-17 ADD PROCESS 5-18 ADD PROFILE 5-22 ADD SERVER 5-23 description of 5-12 Addressed objects 5-1 ALTER commands ALTER ADAPTER 5-24 ALTER DEVICE 5-27 ALTER PATH 5-29 ALTER PROCESS 5-30 ALTER PROFILE 5-31 ALTER TASK 5-32 altering 5-25 description of 5-24 B Body tokens list of 4-2 ZCOM-TKN-MANAGER 4-5 ZCOM-TKN-OBJNAME 4-4, 4-6 ZCOM
D Index Commands (continued) NAMES SERVER 5-61 NAMES SUBSYS 5-61 NAMES TASK 5-64 nonsensitive 5-42 sensitive 5-34 START ADAPTER 5-67 START DEVICE 5-68 START PATH 5-69 START PROCESS 5-70 START SERVER 5-71 START TASK 5-72 STATUS ADAPTER 5-73 STATUS DEVICE 5-75 STATUS FOREVER 5-78 STATUS PATH 5-76 STATUS PROCESS 5-77 STATUS TASK 5-80 STOP ADAPTER 5-81 STOP DEVICE 5-83 STOP PATH 5-83 STOP PROCESS 5-84 STOP SERVER 5-85 STOP TASK 5-86 TRACE PROCESS 5-88 VERSION PROCESS 5-89 VERSION SUBSYS 5-90 configuration dat
M Index M Management application communication between WAN manager 1-1 tokens ZCOM-TKN-CMD-TIMEOUT 2-2 ZSPI-TKN-ALLOW-TYPE 2-2 N NAMES commands description of 5-56 NAMES ADAPTER 5-56 NAMES DEVICE 5-57 NAMES PATH 5-58 NAMES PROCESS 5-59 NAMES PROFILE 5-60 NAMES SERVER 5-61 NAMES SUBSYS 5-61 NAMES TASK 5-64 nonsensitive command 5-42 OBEYFORM parameter 5-42 Objects ADAPTER 5-34 data communication subsystem 5-83 DEVICE 5-15, 5-22, 5-27, 5-28, 5-49 PATH 5-29 PROCESS 5-22 PROFILE 5-39 SERVER 5-8 subordinate 5
T Index START commands (continued) START PATH 5-69 START PROCESS 5-70 START SERVER 5-71 START TASK 5-72 States STOPPED 5-6, 5-7, 5-34 types 5-4, 5-8, 5-68 STATUS commands description of 5-73 STATUS ADAPTER 5-73 STATUS DEVICE 5-75 STATUS FOREVER 5-78 STATUS PATH 5-76 STATUS PROCESS 5-77 STATUS TASK 5-80 STOP commands description of 5-81 STOP ADAPTER 5-81 STOP DEVICE 5-83 STOP PATH 5-83 STOP PROCESS 5-84 STOP SERVER 5-85 STOP TASK 5-86 SUB parameter 5-4, 5-8, 5-43, 5-52 SUBNET 5-13 Subsystem numbers (SSN) 1
U Index Tokens (continued) ZSPI-TKN-SSID 4-4 ZSPI-TKN-USEDLEN 4-4 ZSPI-TKN_LASTERR 4-3 length 1-2 response ZCOM-TKN-RETCODE 4-2 ZSPI-TKN-DATALIST 4-2 ZSPI-TKN-ENDLIST 4-2 ZSPI-TKN-ERRLIST 4-2 value 1-2 ZCOM-TKN-CMD-TIMEOUT 2-2 ZSPI-TKN-ALLOW-TYPE 2-2 ZSPI_TKN_DATALIST 2-5 ZSPI_TKN_RESET_BUFFER 2-6 TRACE command description of 5-88 TRACE PROCESS 5-88 TSM Service Application 5-85, 5-86 Using wild-card characters 5-3 WAN manager (continued) ZCOM-CMD-LISTOBJECTS 3-6 ZCOM-CMD-LOAD 3-6 ZCOM-CMD-START 3-6 ZCOM
Z Index WAN Manager SPI Programming Guide—540013-001 Index -6
