test veritas logo


vxfs_vol_remove(3)

NAME

vxfs_vol_remove - remove a volume from a multi-volume file system

SYNOPSIS

cc -I /opt/VRTS/include -L /opt/VRTS/lib
-l vxfsutil -ldl

#include <sys/types.h>

#include <vxfsutil.h>

int vxfs_vol_remove(int fd, char *volname);

AVAILABILITY

VRTSvxfs

DESCRIPTION

vxfs_vol_remove() removes the component volume with the specified volume volname from the file system. The file descriptor fd can specify any file in the file system.

Cluster File System Issues

For a cluster mounted file system, you can call vxfs_vol_remove() from any node in the cluster. This is a change in behavior starting in the VxFS 5.0 release.

NOTES

In the current implementation, the specified volume must be empty before it can be removed.

RETURN VALUES

vxfs_vol_remove() returns zero on success, non-zero on failure.

ERRORS

EBADF The specified file is not in the file system.
EFAULT One or more of the specified pointer arguments points to an illegal address.
EINVAL The specified volume name is not a valid volume.
ENOENT The specified volume does not exist.
ENOMEM Memory could not be allocated to support the API.
ENOSPC There was insufficient space to perform the operation.
ENOSYS There is no license installed to allow this operation.
EPERM The calling process does not have correct access privileges.
ENXIO An I/O error occurred during the operation.

SEE ALSO

vxfs_ap_assign_ckpt(3), vxfs_ap_assign_file(3), vxfs_ap_assign_fs(3), vxfs_ap_define(3), vxfs_ap_remove(3), vxfs_ap_enforce_file(3), vxfs_ap_enumerate(3), vxfs_ap_query(3), vxfs_ap_query_ckpt(3), vxfs_ap_query_file(3), vxfs_ap_query_fs(3), vxfs_vol_add(3), vxfs_vol_deencapsulate(3), vxfs_vol_encapsulate(3), vxfs_vol_enumerate(3), vxfs_vol_resize(3), vxfs_vol_stat(3)


VxFS 7.4 vxfs_vol_remove(3)