SOAP SERVER Policy Item

If you select the SOAP SERVER policy item from the Network Policy Selection panel, the panel shown in Figure 1 is displayed.

Figure 1. SOAP Server Definitions Panel
   COMMANDS  ACTIONS  HELP                                                      
 ------------------------------------------------------------------------------ 
 AOFGSOAS                     SOAP-Server Definitions         Row 1 to 10 of 20 
 Command ===>                                                   SCROLL===> PAGE 
                                                                                
 Entry Type : Network               PolicyDB Name   : USER_PDB             
 Entry Name : ALL_SYSTEMS_NETWORK   Enterprise Name : USER_ENTERPRISE           
                                                                                
 Enter the SOAP-Server name and select it to define the attributes.             
                                                                                
 Action  Server Name   Description                                              
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
Use this panel to manage your IBM Tivoli Monitoring (ITM) SOAP-Server definitions.
Action
Use this field to select (S) a server for further processing or to delete (D) a server.
Server Name
Enter a unique 8-character name for the server. Any alphabetic, numeric, #, @ and $ character can be used. The first character must be alphabetic.
Description
Enter descriptive text for the server.
Selecting a server leads to the SOAP-Server Attributes panel, as shown in Figure 2.
Figure 2. SOAP-Server Attributes Panel
   COMMANDS  HELP                                                               
 ------------------------------------------------------------------------------ 
 AOFGSOAA                     SOAP-Server Attributes                            
 Command ===>                                                                   
                                                                                
 Entry Type : Network               PolicyDB Name   : USER_PDB             
 Entry Name : ALL_SYSTEMS_NETWORK   Enterprise Name : USER_ENTERPRISE           
                                                                                
 Server Name : KEYATEMS                                                    
                                                                                
 Host name. . . . .                                                             
                                                                                
                                                                                
                             Symbolic host name or IP-address of the SOAP server
 IP stack . . . . .                               
                                                                                
 Port number. . . . 1920      Port number of the SOAP server (1-65535)           
 Protocol . . . . . HTTP      Protocol used for SOAP requests (HTTP or HTTPS) 
 SAF applid . . . . CANDLE    SAF application ID for SOAP server 
 User ID. . . . . .                                        
                                    User ID to log on to SOAP server
 Password . . . . .                                        
                                    Password of the logon user or keyword SAFPW or PTKT   
 Absolute path. . .                                                             
 ///cms/soap                                                                    
                                                                                
                             Absolute path of the SOAP server on that host      
Use this panel to define the SOAP-Server and its attributes. The following fields can be specified:
Host name
This is the required address of the host where the SOAP-Server is running. It can be a symbolic host name (which consists of alphanumeric characters and dots) or an IP address. Both IPv4 and IPv6 address formats are allowed.

An IPv4 address consists of 4 decimal qualifiers, each in the range 0–255, separated by a period. System symbols and system automation symbols are not supported in IPv4 format.

An IPv6 address consists of 8 hexadecimal qualifiers, each in the range 0–FFFF, separated by a colon. You can include system symbols and system automation symbols but you must enter them in uppercase (for example, &AOCCLONE1.). See the note for details on using system automation symbols.

IP stack
This field defines the TCP/IP jobname that indicates the corresponding IP stack. Specify this field only if your system is configured for multiple IP stacks. If nothing is specified, the first active TCP/IP is used.

You can include system symbols and system automation symbols. See the note for details on using system automation symbols.

Port number
This is the port number that the SOAP-Server is listening to. The default for the ITM SOAP-Server is 1920.
Protocol
This field defines how data is exchanged between SA z/OS and the SOAP-Server. SOAP-requests can be issued using the HyperText Transfer Protocol (HTTP) or via HTTPS secured through Secure Socket Layer or Transaction Level Security protocols. The default protocol is HTTP.
SAF applid
This ID is the alphanumeric application name used for verifying the user credentials upon logon to the SOAP server. It's used only when the SOAP server is running on z/OS.

Its maximum length is 8 characters. The default value is CANDLE.

User ID
This defines the user who logs on to the SOAP-Server. The user ID is needed to control access to the SOAP-Server. It can be omitted if security is not implemented for the server.

You can include system symbols and system automation symbols but you must enter them in uppercase (for example, &AOCCLONE1.). See the note for details on using system automation symbols.

Password
This defines the password of the logon user. It is required if a user ID is specified. You can specify the password in clear text. Alternatively, you can specify it to the predefined value PTKT to log on to the SOAP server using a RACF PassTicket. Or you can specify it to the predefined value SAFPW to use the password that is stored in the password data set for the user ID.

You can include system symbols and system automation symbols but you must enter them in uppercase (for example, &AOCCLONE1.). See note for details on using system automation symbols.

Absolute path
This is the absolute path that, together with the host name and the port number, form the complete address of the SOAP-Server. The default path that is used for ITM SOAP-Server is ///cms/soap. If there is no path, specify a forward slash ('/') to denote the root directory as the SOAP-Server path.

You can include system symbols and system automation symbols but you must enter them in uppercase (for example, &AOCCLONE1.). See the note for details on using system automation symbols.

Note: Using system automation symbols (&AOCCLONEx.)

On the AUTOMATION SYMBOLS policy of the system, you are able to define a number of different values for each system. These values can be substituted into Host name, IP stack, User ID, Password, and Absolute path.

To specify that AOCCLONE value x is to be substituted, enter &AOCCLONEx. at the appropriate point in the name. You must specify both the leading ampersand (&) and the trailing period (.).

Additionally, you can specify the tilde (~) to get the 0th (unnumbered) AOCCLONE value substituted. The 0th (unnumbered) AOCCLONE value preserves compatibility with prior releases where only one value was supported and was just named &AOCCLONE. When additional values were supported, they were named starting with &AOCCLONE1.

On the command line, you can enter the following commands:
  • CANCEL (C) - Exits the panel without saving any changes.
  • ENTER - Validates the data entered and refreshes the screen.
  • END - Saves the changes made and exits the panel.