IBM Archive Manager for z/VM

https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0
Admin
IBM Archive Manager for z/VM is a software solution designed to manage archives on the z/VM...
Tokens:12,835
Snippets:139
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### QUERY TAPE Command Examples in z/VM

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-query-tape

Demonstrates the syntax and usage of the QUERY TAPE command in IBM Archive Manager for z/VM. This command displays information about tapes in the archive catalog. It shows examples for general users, all active volumes, and specific volumes, including expected responses and return codes.

```z/VM Command Language
cp smsg amvarkiv query tape                  
Ready;
Return code: 4 Insufficient privileges.
```

```z/VM Command Language
cp smsg amvarkiv query tape               
Ready;
3 volumes selected by spec *.
P20095   contains 8 active parcels. 
P20096   contains 5 active parcels. 
P20098   contains 11 active parcels.
Return code: 0 Command complete.
```

```z/VM Command Language
cp smsg amvarkiv query tape p20098        
Ready;
1 volumes selected by spec P20098.  
P20098   contains 11 active parcels.
Return code: 0 Command complete.
```

--------------------------------

### Set Local Archive Manager Contact Information (Example)

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=file-specifying-local-installation-contact-information

This example demonstrates how to configure the `Local_SVM_Contact` variable to provide installation-level contact details for the Archive Manager service virtual machines. This variable accepts a text string, commonly used for the administrator's name and email address.

```shell
Local_SVM_Contact = Archive Administrator - username@example.com

```

--------------------------------

### CMS Command Example: QUERY CMSLEVEL

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-cms

This snippet demonstrates the usage of the CMS command 'QUERY CMSLEVEL' to retrieve information about the CMS level and service level. It shows the command input and its expected output, including the return code.

```cms
cp smsg amvarkiv cms query cmslevel                     
Ready;                                                  

   CMS Level 23, Service Level 902                      
 Return code: 0   
```

--------------------------------

### Query CPLEVEL Command Example

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-cp

This snippet demonstrates the usage of the CP command 'QUERY CPLEVEL' on z/VM. It shows the command input and the expected output, which includes z/VM version, service level, generation date, IPL date, and return code.

```z/VM
cp smsg amvarkiv cp query cplevel                       
Ready;

 z/VM Version 5 Release 3.0, service level 0902 (64-bit)
 Generated at 12/01/09 16:39:30 CDT                     
 IPL at 06/03/10 08:18:22 CDT                           
 Return code: 0  
```

--------------------------------

### IBM z/VM Archive Manager TRANSFER Command Example

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-transfer

This snippet demonstrates the syntax and expected output of the TRANSFER command in IBM's z/VM Archive Manager. It shows the transfer of a parcel from one user to another, including the completion of catalog and quota revisions.

```shell
smsg amvarkiv transfer 2 to maint                    
Ready;                                             
 Transferring parcel 00000002 from USER1 to MAINT
 Catalog revisions complete. Updating quotas...    
 Quota revisions complete.                         
 Donor catalog entries deleted.                    
 Transfer complete.                                
```

--------------------------------

### Configure Tape Management in Archive Manager for z/VM

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=file-specifying-tape-manager-zvm-settings

This example demonstrates how to configure tape management for IBM Archive Manager for z/VM. It shows how to enable tape handling via EUM and specify the pool owner and name. Ensure that if Tape_Handled_Via_EUM is set to 1, EUM_Pool_Owner and EUM_Pool_Name are also provided.

```configuration
Tape_Handled_Via_EUM = 1
EUM_Pool_Owner = AMVARKIV
EUM_Pool_Name = AMVPOOL

```

--------------------------------

### QUERY TAPE Example: Volume Not in Catalog

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-query-tape

Demonstrates the output of a QUERY TAPE command when the specified volume is not found in the tape catalog. This is useful for troubleshooting or verifying tape catalog contents. The command takes a volume identifier as input and returns a status message.

```shell
cp smsg amvarkiv query tape p20099                    
Ready;                                           
 Return code: 4 No tapes selected by spec P20099.
```

--------------------------------

### Define Storage Class (IBM Z/VM Archive Manager)

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=classes-configuring-storage-class-definitions

This example demonstrates how to define different storage classes using the `Define_Class` command in IBM Z/VM Archive Manager. It covers configurations for minidisk-based and tape-based storage, including simplex and duplex options, retention periods, and access control.

```JCL
*            name     type plex    min/def/max    pri_media                 groups   alt_media  flags
*
* Class DEFAULT:  A minidisk-based single-copy storage class, using AMVARKIV minidisk E00 for storage
*
Define_Class DEFAULT  EDF  SIMPLEX 1 365 365      E00                       ALLUSERS  -       Y Y Y Y N N N
*
* Class CUSTOM:  An example of a minidisk-based DUPLEX media resource, using AMVARKIV minidisks E10 and E11
*
Define_Class CUSTOM   EDF  DUPLEX  1 365 99999999 E10                       ALLUSERS  E11     Y Y Y Y N N N
*
* Class TAPE1:  A simplex storage class that pulls SCRATCH tapes for new media
*
Define_Class TAPE1    TAPE SIMPLEX 1 365 365      SCRATCH                  ALLUSERS  SCRATCH Y Y Y Y Y N N
*
* Class TAPE2:  A duplex storage class that pulls SCRATCH tapes for new media
*
Define_Class TAPE2    TAPE DUPLEX  1 365 365      SCRATCH                  ALLUSERS  SCRATCH Y Y Y Y Y N N
*
* Class SFSSIMPL:  A single-copy class based on SFS-provided media.  Change "filepool" to an appropriate SFS file pool name.
*
Define_Class SFSSIMPL SFS  SIMPLEX 1 365 365      filepool:AMVARKIV.SIMPLEX ALLUSERS -       y y y y y n n
*
* Class SFSDUPL:  A dual-copy class based on SFS-provided media.  Change "filepool" to an appropriate SFS file pool  name.
*
Define_Class SFSDUPL  SFS  Duplex  1 365 99999999 filepool:AMVARKIV.DUPLEX.PRIMARY ALLUSERS filepool:AMVARKIV.DUPLEX.SECONDARY Y Y Y Y Y N N
*
END_CLASSES
```

--------------------------------

### Sample AMVUSERS NAMES File Structure

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=manager-copying-customizing-amvusers-names-file

This is an example of the contents of the AMVUSERS NAMES file. It defines user categories like MASTER, WORKERS, and ADMIN, listing the associated user IDs or virtual machine names under each category. Comments clarify the purpose of each section.

```z/VM CMS File Format
:nick.MASTER
               :list.AMVARKIV
               :COMMENT.Service virtual machines with "MASTER" authority
 
:nick.WORKERS
               :list.AMVWRK01 AMVWRK02 AMVWRK03 AMVWRK04
               :COMMENT.Worker virtual machines
 
:nick.ADMIN
               :list.AMVADMIN MAINT MAINT620 MAINT630
               :COMMENT.Users with ADMIN privileges


```

--------------------------------

### Copy and Edit AMVUSERS NAMES file

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=manager-copying-customizing-amvusers-names-file

This sequence of commands copies the sample AMVUSERS NAMES file (AMVUSERS NAMESAMP) from a SAMPLES minidisk (filemode E) to the production configuration minidisk (filemode Z) and then opens it for editing. The 'COPY' command transfers the file, and 'XEDIT' opens it in the editor.

```z/VM CMS Commands
COPY AMVUSERS NAMESAMP E = NAMES Z
XEDIT AMVUSERS NAMES Z
```

--------------------------------

### Archive Manager for z/VM - QUERY TAPE Command

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-query-tape

The QUERY TAPE command displays information for any tape listed in the archive catalog. It can accept a specific tape volume label, a wildcard expression, or a null value to query all volumes.

```APIDOC
## POST /api/archive-manager/zvm/query-tape

### Description
Displays information for any tape listed in the archive catalog. It supports querying specific tapes, using wildcard expressions, or all tapes.

### Method
POST

### Endpoint
/api/archive-manager/zvm/query-tape

### Parameters
#### Query Parameters
- **tapespec** (string) - Optional - Specifies the tape volume label or a wildcard expression. If null or omitted, all volumes are queried. Wildcard expressions are limited by CMS LISTFILE support.

### Request Body
(Not applicable for this command, parameters are typically passed via query string or as part of the command execution context)

### Request Example
```
POST /api/archive-manager/zvm/query-tape?tapespec=P20098
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message detailing the number of volumes selected and their active parcel counts.
- **return_code** (integer) - The return code of the command execution. 0 indicates success.

#### Response Example
```json
{
  "message": "1 volumes selected by spec P20098. P20098 contains 11 active parcels.",
  "return_code": 0
}
```

#### Error Response (e.g., 403)
- **message** (string) - An error message indicating insufficient privileges or command failure.
- **return_code** (integer) - A non-zero return code indicating an error.

#### Error Response Example
```json
{
  "message": "Insufficient privileges.",
  "return_code": 4
}
```
```

--------------------------------

### Set Default System-Wide Quota Limit in IBM Z/VM Archive Manager

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-set-quota

This snippet shows how to set the default system-wide quota limit using the 'SET QUOTA' command in IBM Z/VM Archive Manager. It requires the 'cp' command and specifies the quota value in 4K blocks. The output confirms the command execution and the return code.

```JCL
cp smsg amvarkiv set quota default 99999999
Ready;
Return code: 0
```

--------------------------------

### Access z/VM Minidisks

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=manager-copying-customizing-amvusers-names-file

These commands are used to access specific minidisks on a z/VM system. 'ACCESS 198 Z' makes minidisk 198 available as filemode Z, and 'ACCESS 2C2 E' makes minidisk 2C2 available as filemode E. These are typically used to access system configuration and sample files.

```z/VM CMS Commands
ACCESS 198 Z
ACCESS 2C2 E
```

--------------------------------

### Configure Archive Catalog SFS Filespace

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=ccacf-specifying-configuration-options-specify-archive-catalog-sfs-filespace

Specify the SFS file pool name (CatalogPool) and the SFS filespace (CatalogSpace) for catalog storage. The default values are AMVPOOL and AMVCATLG. This configuration is essential for managing archive catalogs.

```shell
CatalogPool  = AMVPOOL
CatalogSpace = AMVCATLG
```

--------------------------------

### Archive Manager TRANSFER Command

Source: https://www.ibm.com/docs/en/archive-manager-zvm/1.1.0/index_topic=commands-transfer

The TRANSFER command changes the ownership of an existing archive parcel. It requires system administrator authorization and specific storage class configurations.

```APIDOC
## TRANSFER

### Description

Changes the ownership of an existing archive parcel. This command requires system administrator authorization, and the storage class containing the parcel must be enabled for TRANSFER operations.

### Method

COMMAND

### Endpoint

N/A (This is a command-line interface command)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

```
TRANSFER parcel_id TO new_owner
```

### Response

#### Success Response (200)

Information about the successful transfer of ownership.

#### Response Example

```json
{
  "status": "success",
  "message": "Parcel ownership transferred successfully."
}
```

### Error Handling

- **Authorization Error**: "User not authorized to perform this operation."
- **Storage Class Error**: "Storage class not enabled for TRANSFER operations."
- **Invalid Parcel ID**: "Invalid parcel ID specified."
- **Invalid Owner**: "Invalid new owner specified."
```
Tokens:
Raw