lvm_varyoffvg Subroutine

Base Operating System and Extensions Technical Reference, Volume 1

lvm_varyoffvg Subroutine

Purpose

Varies off a volume group.

Library

Logical Volume Manager Library (liblvm.a)

Syntax

#include <lvm.h>

int lvm_varyoffvg (VaryOffVG)
struct varyoffvg *VaryOffVG;

Description

Note: You must have root user authority to use this subroutine.

The lvm_varyoffvg subroutine varies off a specified volume group. All logical volumes in the volume group to be varied off must be closed.

The varyoffvg structure pointed to by the VaryOffVG parameter is found in the lvm.h file and defined as follows:

struct varyoffvg
       {
        struct unique_id vg_id;
        long lvs_only;
       }  * Varyoffvg;

Field	Description
`lvs_only`	Indicates whether the volume group is to be varied off entirely or whether system management commands, which act on the volume group, are still permitted. If the `lvs_only` field is True, then all logical volumes in the volume group will be varied off, but the volume group is still available for system management commands that act on the volume group. If the `lvs_only` field is False, then the entire volume group is varied off, and system management commands cannot be performed on the volume group. The normal value for this flag is False.
`vg_id`	Specifies the volume group to be varied off.

Field

Description

lvs_only

Indicates whether the volume group is to be varied off entirely or whether system management commands, which act on the volume group, are still permitted. If the lvs_only field is True, then all logical volumes in the volume group will be varied off, but the volume group is still available for system management commands that act on the volume group. If the lvs_only field is False, then the entire volume group is varied off, and system management commands cannot be performed on the volume group. The normal value for this flag is False.

vg_id

Specifies the volume group to be varied off.

Parameters

VaryOfFVG

Points to the varyoffvg structure.

Return Values

Upon successful completion, the lvm_varyoffvg subroutine returns a value of 0.

Error Codes

If the lvm_varyoffvg subroutine fails, it returns one of the following error codes:

LVM_ALLOCERR	A memory allocation error occurred.
LVM_INVALID_PARAM	An invalid parameter was passed into the routine.
LVM_INV_DEVENT	A device entry is invalid and cannot be checked to determine if it is raw.
LVM_LVOPEN	An open logical volume was encountered when it should be closed.
LVM_MAPFOPN	The mapped file, which contains a copy of the volume group descriptor area used for making changes to the volume group, could not be opened.
LVM_MAPFRDWR	An error occurred while trying to write to the mapped file.
LVM_NOTCHARDEV	The device specified is not a raw or character device.
LVM_OFFLINE	The volume group specified is offline. It must be varied on to perform this operation.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The lvm_varyonvg subroutine.

List of Logical Volume Subroutines and Logical Volume Programming Overview in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.