DEFINE_FOCAL

The DEFINE_FOCAL_POINT verb specifies the focal point for a particular Management Services category. When a new focal point is specified, SNAplus2 attempts to establish an implicit primary focal point relationship with the specified focal point by sending an MS_CAPABILITIES request.

VCB Structure

typedef struct define_focal_point
{
   AP_UINT16        opcode;              /* verb operation code              */
   unsigned char    reserv2;             /* reserved                         */
   unsigned char    format;              /* reserved                         */
   AP_UINT16        primary_rc;          /* primary return code              */
   AP_UINT32        secondary_rc;        /* secondary return code            */
   unsigned char    reserved;            /* reserved                         */
   unsigned char    ms_category[8];      /* management services category     */
   unsigned char    fp_fqcp_name[17];    /* Fully qualified focal            */
                                         /*  point cp name                   */
 
   unsigned char    ms_appl_name[8];     /* Focal point application name     */
   unsigned char    description[32];     /* resource description             */
   unsigned char    reserv1[16];         /* reserved                         */
 
   unsigned char    backup;              /* is focal point a backup          */
   unsigned char    reserv3[16];         /* reserved                         */
} DEFINE_FOCAL_POINT;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_DEFINE_FOCAL_POINT

ms_category

Management Services category. This may be either one of the category names specified in the MS Discipline-Specific Application Programs table of Systems Network Architecture: Management Services Reference (see “Related Publications”), padded with EBCDIC spaces (0x40), or a user-defined category. A user-defined category name is an 8-byte type-1134 EBCDIC string, padded with EBCDIC spaces (0x40) if necessary.

fp_fqcp_name

Fully qualified control point name of the focal point. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

ms_appl_name

Focal point application name. This is normally an EBCDIC string, using type-1134 characters; alternatively, it can be one of the MS Discipline-Specific Application Programs specified in Systems Network Architecture: Management Services Reference (see “Related Publications”). The string must be 8 characters long; pad on the right with EBCDIC space characters (0x40) if necessary.

description

A null-terminated text string (0-31 characters followed by a null character) describing the focal point. This string is for information only; it is stored in the node's configuration file and returned on the QUERY_FOCAL_POINT verb, but SNAplus2 does not make any other use of it.

backup

Indicates whether the specified application is the main focal point for this category, or a backup focal point. Possible values are:

AP_YES: Backup focal point (used only if the main focal point is not available).
AP_NO: Main focal point.

Returned Parameters: Successful Execution

If the verb executes successfully, SNAplus2 returns the following parameters:

primary_rc

AP_OK: The focal point was defined as requested.

Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_INVALID_CATEGORY_NAME: The supplied category name contained a character that was not valid.
AP_INVALID_FP_NAME: The fully qualified name or the application name was not valid.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

Returned Parameters: Function Not Supported

If the verb does not execute successfully because the local node configuration does not support it, SNAplus2 returns the following parameters:

primary_rc

AP_FUNCTION_NOT_SUPPORTED: The local node does not support MS network management functions; this is defined by the mds_supported parameter on the DEFINE_NODE verb.

Returned Parameters: Replaced

If the verb does not execute successfully because it is followed by another verb specifying a different focal point, SNAplus2 returns the following parameters.

primary_rc

AP_REPLACED: Another DEFINE_FOCAL_POINT was issued to the same node while this verb was outstanding, specifying a different focal point for the same MS category. This verb was abandoned; the node will attempt to contact the focal point specified by the second verb.

Returned Parameters: Unsuccessful

If the verb does not execute successfully because the focal point relationship cannot be established, SNAplus2 returns the following parameters:

primary_rc

AP_UNSUCCESSFUL

secondary_rc

Possible values are:

AP_IMPLICIT_REQUEST_REJECTED: The specified focal point rejected the request.
AP_IMPLICIT_REQUEST_FAILED: The node could not send the request to the specified focal point; this may be because the specified control point or application was not found.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.

DEFINE_FOCAL_POINT

Technical documentation

» Table of Contents

» Index

VCB Structure

Supplied Parameters

Returned Parameters: Successful Execution

Returned Parameters: Parameter Check

Returned Parameters: Function Not Supported

Returned Parameters: Replaced

Returned Parameters: Unsuccessful

Returned Parameters: Other Conditions