SACONFIG statement

Use the SACONFIG statement to configure the SNMP TCP/IP subagent. If the SACONFIG statement is not specified, the subagent is started by TCP/IP initialization but SNMP SET support is disabled.

Syntax

Tip: Specify the parameters for this statement in any order.

Read syntax diagramSkip visual syntax diagram
             .-------------------------------------.   
             V                                     |   
>>-SACONFig----+---------------------------------+-+-----------><
               | .-AGENT 161----------------.    |     
               +-+--------------------------+----+     
               | '-AGENT--agent_port_number-'    |     
               | .-COMMUNity public------------. |     
               +-+-----------------------------+-+     
               | '-COMMUNity--community_string-' |     
               | .-ENABLed--.                    |     
               +-+----------+--------------------+     
               | '-DISABLed-'                    |     
               | .-OSADISabled-.                 |     
               +-+-------------+-----------------+     
               | '-OSAENabled--'                 |     
               +-+-------------------------+-----+     
               | '-OSASF osasf_port_number-'     |     
               | .-SACACHETime 30---------.      |     
               +-+------------------------+------+     
               | '-SACACHETime cache_time-'      |     
               | .-SETSDISabled-.                |     
               '-+--------------+----------------'     
                 '-SETSENAbled--'                      

Parameters

AGENT
A port number in the range 1 - 65 535 used in establishing communication with the SNMP agent. For the TCP/IP SNMP subagent to communicate with the z/OS® Communications Server SNMP agent, the port number specified must match the port number specified on the -p parameter when the SNMP agent is started. The default value is 161 when processing the initial profile only. If SACONFIG is specified in a VARY TCPIP,,OBEYFILE command data set without the AGENT parameter, the value is unchanged.
COMMUNITY
A 1 - 32 character string used as the community name (or password) in establishing contact with the SNMP agent. It is not converted to uppercase by profile processing. It cannot contain any imbedded white space or control characters (such as blank, tab, end of line, or end of file) and cannot contain any imbedded semicolons (semicolons are treated as comment delimiters). For the TCP/IP SNMP subagent to communicate with the z/OS Communications Server SNMP agent, the community name specified on the COMMUNITY keyword must match one that is defined in the PW.SRC or SNMPD.CONF data set used by the SNMP agent or specified on the -c parameter when the SNMP agent is started.

Restriction: The community name is case sensitive.

For more information about how the community name is used to permit access to the SNMP agent, see Step 1: Configure the SNMP agent (OSNMPD), in z/OS Communications Server: IP Configuration Guide.

The default value is public when processing the initial profile only. If SACONFIG is specified in a VARY TCPIP,,OBEYFILE command data set without the COMMUNITY parameter, the value is unchanged.

DISABLED
If specified in PROFILE.TCPIP at initialization, indicates that the SNMP subagent should not be started. Specify this parameter if you do not require any of the SNMP MIB data supported by the TCP/IP subagent. By default, the SNMP subagent is started by TCP/IP initialization.

If specified in a VARY TCPIP,,OBEYFILE command data set, indicates that the currently active subagent task should be terminated.

SNMP MIB objects supported by the z/OS Communications Server SNMP agent and subagents other than the TCP/IP SNMP subagent are still available. For information about which MIB objects are supported by the SNMP agent and subagent, see the z/OS Communications Server: IP User's Guide and Commands.

ENABLED
Indicates that the SNMP subagent should be started at the completion of the initial profile processing, or of VARY TCPIP,,OBEYFILE command processing.
OSADISABLED
Indicates that OSA Management support is not required at this TCP/IP instance. If this support was previously enabled, then specifying this parameter disables the support.
OSAENABLED
Indicates that OSA Management support is required at this TCP/IP instance. For optimal performance, specify OSAENABLED only at the TCP/IP instance from which Management support is needed. By default, OSA data retrieval is not enabled.

The SNMP subagent must be enabled, as it provides support for retrieval of SNMP management data about OSA devices and links. Therefore, do not specify the DISABLED parameter for this TCP/IP instance.

To retrieve the data, there must also be at least one TCP/IP instance active for which the OSASF parameter and its port number have been specified in the SACONFIG statement.

OSASF osasf_port_number
A value between 0 and 65535. There is no default. Start of changeA value in the range 1 - 65535 indicates a port number and marks the corresponding TCP/IP instance as a candidate to communicate with OSA/SF to retrieve SNMP OSA management data.End of change A value of 0 indicates that the corresponding TCP/IP instance is no longer a candidate to communicate with OSA/SF, in the event that the OSA/SF-to-TCP/IP connection is restarted.

Guideline: When multiple TCP/IP instances specify that OSA management data retrieval is wanted, it is suggested that all be configured with the same OSASF parameter. Only one TCP/IP instance connects directly to OSA/SF. Other instances connect to OSA/SF using this primary TCP/IP instance.

SACACHETIME cache_time
The number of seconds (in the range 0 - 3 600) that the TCP/IP subagent caches management data. If a request for management data is received and the amount of time specified by the cache_time value has expired, the TCP/IP subagent retrieves a new copy of the management data from the TCP/IP stack. A value of 0 indicates that the TCP/IP subagent should not cache any data, but always retrieve the current value of the data from the TCP/IP stack. The default value is 30 seconds when processing the initial profile only. The subagent's cache_time value can also be changed by an SNMP SET request.
SETSDISABLED
Indicates that the SNMP subagent should not process SNMP SET requests.
SETSENABLED
Indicates that the SNMP subagent should process SNMP set requests. For example, SETSENABLED allows a user who issued an SNMP set request to cancel connections and start and stop devices using the SNMP agent security instead of RACF® security. By default, the processing of SNM P SET requests is disabled.

Steps for modifying

To modify parameters for the SACONFIG statement, you must respecify the statement with the new parameters.

  • If you modify the community name or Agent port number, you must recycle the TCP/IP subagent or the SNMP Agent for the changes to take effect.
  • If you modify the OSA/SF port number, you must recycle the TCP/IP subagent or the OSA/SF IOASNMP application for the changes to take effect.

Examples

SACONFIG COMMUNITY USACCESS AGENT 528
SACONFIG DISABLED
SACONFIG SETSENABLED OSAENABLED OSASF 2026

Usage notes

When you specify more than one SACONFIG statement in the initial profile data set, or in a data set referenced by the VARY TCPIP,,OBEYFILE command, the default value ENABLED is set even if the DISABLED value was specified in a previous SACONFIG statement.