Retrieve Configuration Source (RTVCFGSRC)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Retrieve Configuration Source (RTVCFGSRC) command is used to retrieve the CL source statements which describe existing configuration objects. These source statements are placed into a source file member. The CL source may be used to re-create the configuration objects.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| CFGD | Configuration description | Single values: *ALL Other values (up to 256 repetitions): Generic name, name |
Required, Positional 1 |
| CFGTYPE | Type |  *ALL, *NWSD, *LIND, *CTLD, *DEVD, *MODD, *COSD, *NTBD |
Required, Positional 2 |
| SRCFILE | Source file | Qualified object name | Optional, Positional 3 |
| Qualifier 1: Source file | Name, QCLSRC | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| SRCMBR | Source member | Name, *CFGD | Optional, Positional 4 |
| RTVOPT | Retrieve option | *NET, *OBJ | Optional |
| MBROPT | Member option | *ADD, *REPLACE | Optional |
| TEXT | Text 'description' | Character value, *CFGDTXT, *BLANK | Optional |
| Top |
Configuration description (CFGD)
Specifies the names of configuration objects to be retrieved.
This is a required parameter.
- *ALL
- All configuration objects of the specified configuration type (CFGTYPE parameter) are retrieved.
- generic-configuration-object-name
- Specify the generic name of the configuration description name. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name.
- configuration-description-name
- Specify the user-defined name of the configuration description.
Up to 256 names can be specified. These can be any combination of configuration object and generic names.
You can enter multiple values for this parameter.
| Top |
Type (CFGTYPE)
Specifies the type of configuration object to be retrieved.
- *ALL
- All network server descriptions, lines, controllers, devices, modes, classes-of-service, and NetBIOS descriptions matching the specified names are retrieved in the following order:
- Connection Lists
- Network server descriptions
- Line descriptions
- Controller descriptions
- Device descriptions
- Mode descriptions
- Class-of-service descriptions
- NetBIOS descriptions
- SWTLINLST for controller descriptions
- Printer for remote displays
- *NWSD
- All network server descriptions matching the specified names are retrieved.
- *LIND
- All line descriptions that match the name specified on the Configuration description prompt (CFGD parameter) are retrieved.
- *CTLD
- All controller descriptions that match the name specified on the Configuration description prompt (CFGD parameter) are retrieved.
- *DEVD
- All device descriptions that match the name specified on the Configuration description prompt (CFGD parameter) are retrieved.
- *MODD
- All mode descriptions that match the name specified on the Configuration description prompt (CFGD parameter) are retrieved.
- *COSD
- All class-of-service descriptions that match the name specified on the Configuration description prompt (CFGD parameter) are retrieved.
- *NTBD
- All NetBIOS descriptions matching the specified names are retrieved.
| Top |
Source file (SRCFILE)
Specifies the name and library of the previously created database source file that contains the source file member.
The possible source-file values are:
- QCLSRC
- The source file named QCLSRC is used.
- source-file
- Specify the name of a source file.
The possible library values are:
- *LIBL
- All libraries in the library list for the current thread are searched until the first match is found.
- *CURLIB
- The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
- library-name
- Specify the library where the source file is located.
| Top |
Source member (SRCMBR)
Specifies the name of the database source file member into which the CL source statements are written.
- *CFGD
- The name of the source member is the configuration object name if there is only one name specified and the name is not generic or *ALL. Otherwise, the name is CFGSRC.
- source-member-name
- Specify the name of the source file member that contains the CL source statements.
| Top |
Retrieve option (RTVOPT)
Specifies which attachment information is retrieved for the specified objects.
- *NET
- For network interfaces, each network interface description and the descriptions of its attached nonswitched lines, controllers, and devices are retrieved. For lines, each line description and the descriptions of its attached nonswitched controllers and devices are retrieved. For controllers, each controller description and the descriptions of its attached devices are retrieved. For network interfaces, lines, and controllers, switched attachment information is also retrieved.
- *OBJ
- Each specified configuration object description is retrieved with all attachment information.
RTVOPT is ignored if the CFGTYPE parameter is *ALL.
| Top |
Member option (MBROPT)
Specifies whether the new records replace or are added to the existing records.
- *REPLACE
- The system clears the existing member and adds the new records.
- *ADD
- The system adds the new records to the end of the existing records.
| Top |
Text 'description' (TEXT)
Specifies the text that briefly describes the object.
- *CFGDTXT
- The text description is the same as the text description of the object specified by the CFGD parameter unless there is more than one object specified or the name is a generic name. In this case, *BLANK is used for the text description.
- *BLANK
- No text is specified.
- 'description'
- Specify no more than 50 characters of text, enclosed in apostrophes.
| Top |
Examples
RTVCFGSRC CFGD(CTL*) CFGTYPE(*CTLD)
SRCMBR(CTLS) RTVOPT(*OBJ)
This command places CL source statements in the file member CTLS in the source file QCLSRC. These source statements can be used to re-create object descriptions for all existing controllers with names beginning with CTL.
| Top |
Error messages
*ESCAPE Messages
- CPF2207
- Not authorized to use object &1 in library &3 type *&2.
- CPF263E
- File member &1 contains its maximum sequence number.
- CPF263F
- No objects found.
- CPF264A
- Record length of &1 in library &2 is too small.
- CPF264C
- Source file member &1 not found.
- CPF9810
- Library &1 not found.
- CPF9820
- Not authorized to use library &1.
- CPF9847
- Error occurred while closing file &1 in library &2.
- CPF9848
- Cannot open file &1 in library &2 member &3.
- CPF9849
- Error while processing file &1 in library &2 member &3.
| Top |