Retrieve SMG Object (RTVSMGOBJ)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Retrieve System Manager Object (RTVSMGOBJ) command provides the capability of retrieving an IBM i object from a managed system.
Note:
A change request is automatically submitted which can be viewed to determine the status of this command. A message is returned identifying the name of the change request.
Restrictions:
- The object cannot reside in the QTEMP library.
- An object can only be retrieved from a single managed system.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| OBJ | Object | Qualified object name | Required, Positional 1 |
| Qualifier 1: Object | Name | ||
| Qualifier 2: Library | Name, *CURLIB | ||
| OBJTYPE | Object type | Character value | Required, Positional 2 |
| MBR | Member | Name, *ALL, *FIRST, *LAST | Optional |
| CPNAME | Managed system node names | Element list | Optional |
| Element 1: Network identifier | Communications name, *NETATR | ||
| Element 2: Control point | Communications name | ||
| TGTRLS | Target release | *CURRENT, *PRV, V5R4M0, V6R1M0, V7R1M0 | Optional |
| REPLACE | Replace object | *NO, *YES | Optional |
| DTACPR | Data compression | *NONE, *SNA | Optional |
| Top |
Object (OBJ)
Specifies the qualified name to be retrieved.
The possible library values are one of the following:
- *CURLIB
- The current library for the job is used to locate the object.
- library-name
- Specify that only the library named in this parameter is to be searched.
The possible object name value is:
- object-name
- Specify that only characters A through Z, 0 through 9, dollar sign, at sign, and number sign are used in the object name.
| Top |
Object type (OBJTYPE)
Specifies the object to be used.
- object-type
- Specify the object type.
- *FILEDATA
- A file member is sent without the file attributes.
| Top |
Member (MBR)
Specifies the IBM i physical file member name. It is ignored unless the object type is *FILE or *FILEDATA.
- *ALL
- The entire physical file is to be retrieved. *ALL must be used if the file is not a physical file.
- *FIRST
- Only the first member is retrieved. The member name is determined when the activity is run.
- *LAST
- Only the last member is retrieved. The member name is determined when the activity is run by the date the member was added to the physical file.
- member-name
- Specify names of the member to be retrieved.
| Top |
Managed system node names (CPNAME)
Specifies the APPN control point names of the managed system from which this activity is to be retrieved.
- *NETATR
- The network ID of the local system is used. This is useful when the node specified is in the same network as the local system.
- network-identifier
- Specify the managed system APPN network identifier which the activity is to be performed.
The possible value for the control point name is:
- control-point-name
- Specify the managed system APPN control point name on which the activity is to be performed.
| Top |
Target release (TGTRLS)
Specifies the release of the operating system on which you intend to use the object. This parameter is ignored for objects with global names that are in the SystemView distribution repository or for actions other than send or retrieve.
- *CURRENT
- The object is used on the release of the operating system currently running on your system. If V7R1M0 is running on your system, *CURRENT means that you intend to use the object on a system with V7R1M0 installed. The object can also be used on a system with any later release of the operating system installed.
- *PRV
- The object is intended for a system which is at the previous release level compared to the local system.
- release-level
- Specify the release level in the VxRxMx format. The object is used on a system with the specified release or with any later release of the operating system installed.
Valid values depend on the current version, release, and modification level, and they change with each new release.
| Top |
Replace object (REPLACE)
Specifies if the object should be replaced if it already exists. This parameter cannot be specified for actions other than for *SND, *SNDRUN, and *RTV.
- *NO
- An error is returned if the object already exists.
- *YES
- The object is replaced if it already exists.
| Top |
Data compression (DTACPR)
Specifies that data is compressed when retrieving. Compression is valid only for object type *FILEDATA. SNA compression with a blank prime compression character is performed.
- *SNA
- The file data is compressed when retrieved.
- *NONE
- The file data is not compressed when retrieved.
| Top |
Examples
RTVSMGOBJ OBJ(DEVLLIB/NEWPGM) OBJTYPE(*PGM)
CPNAME(*NETATR DEVSYS)
This command retrieves program NEWPGM in library DEVLLIB from the development system.
| Top |
Error messages
None
| Top |