z/OS Communications Server: IP Programmer's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Filter request section

z/OS Communications Server: IP Programmer's Guide and Reference
SC27-3659-02

For requests that support filters, you can use filters to limit the data that is returned to data that matches the specified filter values. Not all filters are supported for all requests.

The following request types do not support any filters. If you specify filters for these requests, the filters are ignored.
  • GetGlobalStats
  • GetIfs
  • GetIfStats
  • GetIfStatsExtended
  • GetProfile
  • GetRnics
  • GetSmcLinks
  • GetStorageStatistics
  • GetSysplexXCF
  • GetTnMonitorGroups
  • GetTnProfile

The following table describes all possible filters.

Table 1. Available EZBNMIFR poll-type request filters
Filter item Filter item value
Application data An EBCDIC character string (right-padded with blanks if less than 40 characters in length) associated with a TCP socket by the owning application using the SIOCSAPPLDATA IOCTL. The application data filter can have wildcard characters. Use a question mark (?) as a wildcard for a single character and an asterisk (*) as a wildcard for zero or more characters.

For z/OS® Communications Server applications, see Application data for applications that use the SIOCSAPPLDATA ioctl as a source for information about the content, format, and meaning of the application data that the applications associate with the sockets that they own. For other applications, see the documentation that is supplied by the application.

See Miscellaneous programming interfaces for more information about associating application data with a socket.

Application name An EBCDIC application name (right-padded with blanks if less than 8 characters in length) of the SNA application name in session with the TN3270E secondary LU representing the client. The application name can have wildcard characters. Use a question mark (?) as a wildcard for a single character, and an asterisk (*) as a wildcard for 0 or more characters. For example, the value A?C* matches all application names with a first character A and a third character C, but does not match 2-character names, names beginning with B through Z, or names with anything other than C in the third position.
ASID A 16-bit address space number of a socket application address space.
Destination XCF IP address and family A 32-bit IPv4 address or a 128-bit IPv6 address. The destination XCF IP address family field must also be set to indicate whether the destination XCF IP address filter value is an IPv4 address or an IPv6 address. For IPv4 addresses, the destination XCF IP address filter value can be specified as either an IPv4 address (for example, 9.1.2.3) or an IPv4-mapped IPv6 address (for example, ::FFFF:9.1.2.3). A null address can be specified as either an IPv4 address (0.0.0.0), an IPv4-mapped IPv6 address (::FFFF:0.0.0.0), or an IPv6 address (::). The destination XCF IP address family field must be set to AF_INET for an IPv4 address or AF_INET6 for an IPv6 address.
Destination XCF IP address prefix A 16-bit signed binary value that specifies the number of destination XCF IP address bits to use. For example, the value 12 specifies that the first 12 bits of a destination XCF IP address are compared to the first 12 bits of the destination XCF IP address filter value. The value 0 specifies that all address bits are compared. A value greater than 32 for an IPv4 address, or greater than 128 for an IPv6 address, specifies that all address bits are compared.
Dynamic virtual IP address and family A 32-bit IPv4 address or a 128-bit IPv6 address. The dynamic VIPA address family field must also be set to indicate whether the DVIPA filter value is an IPv4 address or an IPv6 address. For IPv4 addresses, the DVIPA filter value can be specified as either an IPv4 address (for example, 9.1.2.3) or an IPv4-mapped IPv6 address (for example, ::FFFF:9.1.2.3). A null address can be specified as either an IPv4 address (0.0.0.0), an IPv4-mapped IPv6 address (::FFFF:0.0.0.0), or an IPv6 address (::). The dynamic virtual IP address family field must be set to AF_INET for an IPv4 address or AF_INET6 for an IPv6 address.
Dynamic virtual IP address port A 16-bit unsigned binary port number.
Dynamic virtual IP address prefix A 16-bit signed binary value that specifies the number of dynamic virtual IP address bits to use. For example, the value 12 means that the first 12 bits of a dynamic VIPA are compared to the first 12 bits of the dynamic VIPA filter value. The value 0 means that all address bits are compared. A value greater than 32 for an IPv4 address, or greater than 128 for an IPv6 address, means that all address bits are compared.
Interface name An EBCDIC interface name (right-padded with blanks if less than 16 characters in length) of an IPv4 or IPv6 interface. The interface name can have wildcard characters. Use a question mark (?) as a wildcard for a single character, and use an asterisk (*) as a wildcard for zero or more characters. For example, the value A?C* matches all interface names with a first character A and a third character C, but does not match 2-character names, names beginning with B through Z, or names that have anything other than the character C in the third position.
Local or source IP address A 32-bit IPv4 address or a 128-bit IPv6 address. The local or source IP address filter value is specified as the IP address field within a sockaddr structure. The sockaddr address family field must be set to indicate whether the local IP address filter value is an IPv4 address or an IPv6 address. For IPv4 connections, the local IP address filter value can be specified as either an IPv4 address (for example, 9.1.2.3) or an IPv4-mapped IPv6 address (for example, ::FFFF:9.1.2.3). For all connections, a null address can be specified as either an IPv4 address (0.0.0.0), an IPv4-mapped IPv6 address (::FFFF:0.0.0.0), or an IPv6 address (::).
Local or source IP address prefix A 16-bit signed binary value that specifies the number of local or source IP address bits to use. For example, the value 12 means that the first 12 bits of a local or source IP address are compared to the first 12 bits of the local IP address filter value. The value 0 means that all address bits are compared. A value greater than 32 for an IPv4 address, or greater than 128 for an IPv6 address, means that all address bits are compared.
Local or source port A 16-bit unsigned binary port number.
LU name An EBCDIC LU name (right-padded with blanks if less than 8 characters in length) of the TN3270E LU representing the client. Use a question mark (?) as a wildcard for a single character and an asterisk (*) as a wildcard for zero or more characters. For example, the value A?C* matches all names with a first character A and a third character C, but does not match 2-character names, names beginning with B through Z, or names with anything other than C in the third position.
Monitor group identifier A 32-bit unsigned binary value assigned by the TN3270E Telnet server to identify up to 255 unique monitor groups. Any parameter change within an existing monitor group or a new monitor group causes the TN3270E Telnet server to assign a new identifier. The identifier is reported in the monitor group table and connection data allowing a comparison between monitoring criteria and actual connection performance. The monitor group identifier can be obtained by issuing the GetTnMonitorGroups request.
Remote or destination IP address A 32-bit IPv4 address or a 128-bit IPv6 address. The remote or destination IP address filter value is specified as the IP address field within a sockaddr structure. The sockaddr address family field must be set to indicate whether the remote IP address filter value is an IPv4 address or an IPv6 address. For IPv4 connections, the remote IP address filter value can be specified as either an IPv4 address (for example, 9.1.2.3) or an IPv4-mapped IPv6 address (for example, ::FFFF:9.1.2.3). For all connections, a null address can be specified as either an IPv4 address (0.0.0.0), an IPv4-mapped IPv6 address (::FFFF:0.0.0.0), or an IPv6 address (::).
Remote or destination IP address prefix A 16-bit signed binary value specifying the number of remote or destination IP address bits to use. For example, the value 12 means that the first 12 bits of a remote or destination IP address are compared to the first 12 bits of the remote IP address filter value. The value 0 means that all address bits are compared. A value greater than 32 for an IPv4 address, or greater than 128 for an IPv6 address, means that all address bits are compared.
Resource ID A 32-bit unsigned binary TCP⁄IP resource identifier (Client ID in Netstat displays).
Resource name An EBCDIC job name, right-padded with blanks if less than 8 characters long, of a socket application address space (Client Name in Netstat displays). A question mark can be used to wildcard a single character, and an asterisk can be used to wildcard zero or more characters. For example, the value A?C* matches all names with a first character A and a third character C, but does not match two-character names or names beginning with B through Z.
Remote or destination port A 16-bit unsigned binary port number.
Server resource ID A 32-bit unsigned binary TCP⁄IP resource identifier of the related server listening connection.
Target IP address and family A 32-bit IPv4 address or a 128-bit IPv6 address. The target IP address family field must also be set to indicate whether the target IP address filter value is an IPv4 address or an IPv6 address. For IPv4 addresses, the destination XCF IP address filter value can be specified as either an IPv4 address (for example, 9.1.2.3) or as an IPv4-mapped IPv6 address (for example, ::FFFF:9.1.2.3). A null address can be specified as either an IPv4 address (0.0.0.0), as an IPv4-mapped IPv6 address (::FFFF:0.0.0.0), or as an IPv6 address (::). The target IP address family field must be set to AF_INET for an IPv4 address or AF_INET6 for an IPv6 address.
Target IP address prefix A 16-bit signed binary value that specifies the number of target IP address bits to use. For example, the value 12 means that the first 12 bits of a target IP address are compared to the first 12 bits of the target IP address filter value. The value 0 means that all address bits are compared. A value greater than 32 for an IPv4 address, or greater than 128 for an IPv6 address, means that all address bits are compared.

You can specify 1 - 4 filter elements. Each filter element can contain any combination of the items that are listed in Table 1. A filter element that does not have any applicable items matches all data for the request. The data must match all items that are specified in a filter element to pass that filter check; data must pass at least one filter check to be selected.

If you do not specify any filters (triplet offset field is 0, or triplet element count field is 0, or triplet element length field is 0), then the caller is requesting all information that is applicable to that request except for the GetFTPDaemonConfig request type.

The following list shows the applicable filter items that each request type supports. If you specify inapplicable filters for a particular request type, they are ignored.
  • GetConnectionDetail
    • Application data
    • ASID
    • Local or source IP address
    • Local or source IP address prefix
    • Local or source port
    • Remote or destination IP address
    • Remote or destination IP address prefix
    • Remote or destination port
    • Resource ID
    • Resource name
    • Server resource ID
  • GetDVIPAConnRTab
    • Destination XCF IP address and family
    • Destination XCF IP address prefix
    • Local or source IP address
    • Local or source IP address prefix
    • Local or source port
    • Remote or destination IP address
    • Remote or destination IP address prefix
    • Remote or destination port
  • GetDVIPAList
    • Dynamic virtual IP address and family
    • Dynamic virtual IP address prefix
    • Interface name
  • GetDVIPAPortDist
    • Destination XCF IP address and family
    • Destination XCF IP address prefix
    • Dynamic virtual IP address and family
    • Dynamic virtual IP address port
    • Dynamic virtual IP address prefix
  • GetDVIPARoute
    • Destination XCF IP address and family
    • Destination XCF IP address prefix
    • Target IP address and family
    • Target IP address prefix
  • GetFTPDaemonConfig
    • ASID of an FTP daemon address space.
  • GetTCPListeners
    • Application data
    • ASID
    • Local or source IP address
    • Local or source IP address prefix
    • Local or source port
    • Resource ID
    • Resource name
  • GetTnConnectionData
    • Application name
    • Local or source IP address
    • Local or source IP address prefix
    • Local or source port
    • LU name
    • Monitor group identifier
    • Remote or destination IP address
    • Remote or destination IP address prefix
    • Remote or destination port
    • Resource ID
    • Server resource ID
  • GetUDPTable
    • ASID
    • Local or source IP address
    • Local or source IP address prefix
    • Local or source port
    • Resource ID
    • Resource name

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014