vxfs_ap_query_ckpt (3)

NAME

vxfs_ap_query_ckpt - return information about allocation policies assigned to a Storage Checkpoint

SYNOPSIS

For 32-bit applications:

cc -I /opt/VRTS/include -L /opt/VRTS/lib

-l vxfsutil -ldl

For 64-bit applications:

cc -I /opt/VRTS/include -L /opt/VRTS/lib/64

-l vxfsutil -ldld

For both applications:

#include <sys/types.h>

#include <vxfsutil.h>

int vxfs_ap_query_ckpt(int fd, char *ckptname, char *datapol, char *metapol);

AVAILABILITY

VRTSvxfs

DESCRIPTION

The vxfs_ap_query_ckpt() function retrieves information about the Storage Checkpoint allocation policies assigned to the given Storage Checkpoint. The datapol and metapol arguments must point to buffers of (FSAP_NAMESZ + 1) bytes, which are filled in with the name of the policy (if any) and NULL-terminated. If no policy is assigned, the string "NONE" is returned. datapol is the name of the data policy that can be created with fsapadm(1M) or through the vxfs_ap_define() API. metapol is the name of the metadata policy that can be created with fsapadm(1M) or through the vxfs_ap_define() API. The file descriptor fd specifies a file within the Storage Checkpoint.

To use this function, specify -l vxfsutil while linking. Specify the /opt/VRTSfssdk/5.0/lib directory for 32-bit executables, or the /opt/VRTSfssdk/5.0/lib/64 directory for 64-bit executables.

If the LIBVXFSUTIL_DLL_PATH environment variable is defined, it should be set to the name of the vxfsutil.so file, such as ~/mylib/vxfsutil.so. If undefined, this variable is assumed to point to the 32-bit and 64-bit vxfsutil.so files, /opt/VRTSvxfs/lib/vxfsutil.so and /opt/VRTSvxfs/lib/64/vxfsutil.so, respectively.

NOTES

This function is supported only on Version 6 and later disk layouts. This API supports file system versions 6.0 and above.

RETURN VALUES

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

ERRORS

EAGAIN The file system is not currently frozen.
EFAULT One or more of the specified pointer arguments points to an illegal address.
EFBIG An was made to reserve space larger than the maximum file size for this process.
EINVAL The command or argument is invalid.
EIO An I/O error occurred during the operation.
ENOENT One or more of the named policies does not exist.
ENOSYS There is no license installed to allow this operation.
ENOTSUP This operation is not supported by the disk layout version of the specified file system. Use vxupgrade(1m) to enable this operation.
ENXIO There is no such device or address.
EPERM The effective user ID of the calling process does not have appropriate privileges to perform this operation.

EXAMPLES

To query a Storage Checkpoint for its assigned policies:
# vxfs_ap_query_ckpt(fd, checkpoint_name data_policy, meta_policy);

SEE ALSO

vxfs_ap_assign_ckpt(3), vxfs_ap_assign_file(3), vxfs_ap_assign_fs(3), vxfs_ap_define(3), vxfs_ap_define2(3), vxfs_ap_remove(3), vxfs_ap_enforce_ckpt(3), vxfs_ap_enforce_file(3), vxfs_ap_enforce_file2(3), vxfs_ap_enumerate(3), vxfs_ap_query(3), vxfs_ap_query2(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_remove(3), vxfs_vol_resize(3), vxfs_vol_stat(3)


VxFS 5.1 SP1 vxfs_ap_query_ckpt (3)