search

zowe / cics-for-zowe-client

Monorepo for all CICS related APIs and Apps built by Zowe Clients
https://www.zowe.org/
Eclipse Public License 2.0
2 stars 3 forks source link

Document that the --regionName can also be set to be a CICSSystemGroup value #75

Open Joe-Winchester opened 2 years ago

Joe-Winchester commented 2 years ago

When a CICS profile is created for a CICSPlex region, the --cicsPlex value is set to the plex name and the --regionName set to one of the plex's regions, allowing a query like zowe cics getResource CICSProgram --cicsPlex PLEX1 --regionName REGION1 to show all programs in REGION1 in the plex. The REST API constructed is a get request CICSSystemManagement/CICSProgram/PLEX1/REGION1. Customers with plexes group regions together in system groups, using the table CICSSystemGroup. This can be used as the last segment of the URL, so if there is a system group AORS or FORS or ALLGRP (the name is up to the user to define), then a valid query is CICSSystemManagement/CICSProgram/PLEX1/AORS where the system group can be used in place of the regionName. In the CMCI documentation this is known as scope, that can be either a region or a system group.

Doing some tests it's possible to specify a system group in the --regionName attribute.

This issue is to change the imperative documentation so that the description for --regionName lets users know that it can be a region or a system group.

github-actions[bot] commented 5 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.