19
Fri, Apr
5 New Articles

TechTip: Using Vary Configuration Exit Points on i5/OS

Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times
This article focuses on the QIBM_QDC_VRYEXIT exit point (which was introduced in V5R3) by discussing some of its potential uses and benefits. Also featured is some skeleton C code (though any ILE language should suffice) to help you get your feet wet in writing your own customized vary configuration exit program.

Many objects within i5/OS can be varied on and varied off. These objects include devices, controllers, lines, network servers, etc. In many cases, it may be desirable to perform some set of user-defined actions at vary on or vary off time. For example, consider a topology in which you have two systems that share a switchable IASP between them. Assume that when the IASP is attached to a system, a given subsystem should also be active (i.e., if and only if the IASP is attached). That means that when the IASP is switched, the subsystem on the "old" side must be ended and then started on the "new" side. But how can you realize this requirement without manual intervention? The answer is that you should create your own exit program using the QIBM_QDC_VRYEXIT exit point!

Which Exit Point Format Should I Use?

Each exit point is accompanied by an exit point format name. Depending on the exit point format name specified, the system will supply your exit program with different arguments and expect different return values. The QIBM_QDC_VRYEXIT exit point supports four exit point format names:

  • PRON0100—The exit programs are called prior to the object being varied on.
  • PSON0200—The exit programs are called after the object vary on has started.
  • PROF0100—The exit programs are called prior to the object being varied off.
  • PSOF0200—The exit programs are called after the object vary off has started.

Notice that you can choose to have your custom logic occur either before or after the vary operations occur. It's also worth mentioning that if the logic occurs prior to the vary operation, you have the option to specify a return code dictating whether or not the vary operation should continue or halt (i.e., assuming a forced vary wasn't issued). Once you've selected the exit point format(s) in which you're interested, it's time to create your program(s).

Example Time

All right, you've learned about exit points, exit point formats, and which exit point formats the QIBM_QDC_VRYEXIT exit point supports; now it's time to look at an example from beginning to end. The following example demonstrates how to create an exit program that will be called after an ASP device description is varied on.

(Note that the PSON0200 exit point format name is assumed for this example.)

Step 1: Given the PSON0200 exit point format name, use the i5/OS Information Center to determine the arguments your program's expected to support. You will find that it must support four arguments: ObjectName [CHAR(10)], ObjectType [CHAR(10)], FormatName [CHAR(8)] and Status [BINARY(4)].

Step 2: Create your exit program within ILE. The following skeleton code is written in ILE C:

#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

// The following C struct mimics the data passed by the
// QIBM_QDC_VRYEXIT exit program using the PSON0200 exit point
// format name
typedef struct {
  // name of object being processed
  char object_name[10];
   // type of object being processed
  char object_type[10];
  // user exit format name being used
  char format_name[8];
  int  status;           // vrycfg status;
 // 0 = successful,
                         // 1 = not successful,
                         // 2 = rejected by pre-proc exit pgm,
                         // 3 = status of vary request unknown
} PSO200_fmt_t;

/**
 * Main program entry point.
 */
int main(int argc, char *argv[]) {
  PSO200_fmt_t input;

  // Populate the PSO200_fmt_t structure with program arguments
  memcpy(&input, (PSO200_fmt_t *) argv[1], sizeof(PSO200_fmt_t));

  // At this point, the input structure contains all of the information
  // supplied to us by the operating system. We can now proceed to
  // perform our user-defined logic here (e.g., start the
  // appropriate subsystem).

  return 0;
}

Step 3: Compile your ILE program object (e.g., given the program in Step 2, you should use the CRTBNDC CL command).

Step 4: Register your exit program with the system. You can use the following CL command:

ADDEXITPGM EXITPNT(QIBM_QDC_VRYEXIT)
FORMAT(PSON0200) 
PGMNBR(*LOW)
            PGM(MYLIB/MYPGM)
THDSAFE(*SYSVAL)
PGMDTA(*JOB *CALC DEVDASPD)
TEXT('EXAMPLE EXIT PROGRAM')

You could alternatively use the WRKREGINF CL command and work your way through the various prompts to achieve the same result (but don't forget to populate the PGMDTA argument). You can also use WRKREGINF to deregister exit programs whose use is no longer wanted.

Step 5: Using the VRYCFG CL command, test your exit program by varying off and then varying on an ASP device description. Your exit program will be called post-vary-on time.

My Point of Exit!

By now, you should see just how easy it is to get started creating your very own exit programs, specifically those involving device vary configurations. Again, the QIBM_QDC_VRYEXIT exit point was added in V5R3, so its potential usability should be very widespread by now. If you don't have an immediate need for this today, it's definitely something handy to keep within your programming tool belt.

Joe Cropper is a Software Engineer at IBM in Rochester, Minnesota. He works as part of the Cloud Systems Software Development organization, focusing on virtualization and cloud management solutions. Joe has held a number of roles in other organizations as well, ranging from IBM i and Electronic Support. His areas of expertise include virtualization and cloud management, OpenStack, Java EE, and multi-tiered applications. Joe can be reached via email at This email address is being protected from spambots. You need JavaScript enabled to view it..

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: