Manpages

•

• 静 的 ラ イ ブ ラ リ ー

(libfoo.a)

• 圧 縮 さ れ た

ext2 フ ァ イ ル シ ス テ ム と し て Linux 旧 形 式 の initrd (RHEL

•

x86 Linux vmlinuz カ ー ネ ル

’b’ ブ ロ ッ ク 特 殊

’c’ キ ャ ラ ク タ ー 特 殊

’d’ デ ィ レ ク ト リ

’f’

’l’ シ ン ボ リ ッ ク リ ン ク

’r’ 通 常 の フ ァ イ ル

’s’ ソ ケ ッ ト

’h’

’w’

Whiteout inode (BSD)

’u’

This function returns a "struct guestfs_tsk_dirent_list *", or NULL if there was an error. The caller must call "guestfs_free_tsk_dirent_list" after use.

•

The resulting list is written to an external file.

•

Items (filenames) in the result are separated by "\0" characters. See find(1) option -print0.

•

結 果 の 一 覧 は ソ ー ト さ れ て い ま せ ん 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.74 に お い て 追 加 )

guestfs_find_inode
struct guestfs_tsk_dirent_list *
guestfs_find_inode (guestfs_h *g,
const char *device,
int64_t inode);

Searches all the entries associated with the given inode.

For each entry, a "tsk_dirent" structure is returned. See "filesystem_walk" for more information about "tsk_dirent" structures.

This function returns a "struct guestfs_tsk_dirent_list *", or NULL if there was an error. The caller must call "guestfs_free_tsk_dirent_list" after use.

This long-running command can generate progress notification messages so that the caller can display a progress bar or indicator. To receive these messages, the caller must register a progress event callback. See "GUESTFS_EVENT_PROGRESS".

This function depends on the feature "libtsk". See also "guestfs_feature_available".

(Added in 1.35.6)

guestfs_findfs_label
char *
guestfs_findfs_label (guestfs_h *g,
const char *label);

This command searches the filesystems and returns the one which has the given label. An error is returned if no such filesystem can be found.

To find the label of a filesystem, use "guestfs_vfs_label". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_findfs_uuid
char *
guestfs_findfs_uuid (guestfs_h *g,
const char *uuid);

This command searches the filesystems and returns the one which has the given UUID. An error is returned if no such filesystem can be found. フ ァ イ ル シ ス テ ム の UUID を 見 つ け る に は "guestfs_vfs_uuid" を 使 用 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_fsck
int
guestfs_fsck (guestfs_h *g,
const char *fstype,
const char *device);

This runs the filesystem checker (fsck) on "device" which should have filesystem type "fstype". 返 さ れ た 整 数 は 状 態 で す 。 "fsck" か ら の 状 態 コ ー ド の 一 覧 は fsck(8) を 参 照 し て く だ さ い 。 注 :

A non-zero return code can mean "success", for example if errors have been corrected on the filesystem.

This command is entirely equivalent to running "fsck -a -t fstype device". こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.0.16 に お い て 追 加 )

guestfs_fstrim
int
guestfs_fstrim (guestfs_h *g,
const char *mountpoint,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_FSTRIM_OFFSET, int64_t offset,
GUESTFS_FSTRIM_LENGTH, int64_t length,
GUESTFS_FSTRIM_MINIMUMFREEEXTENT, int64_t minimumfreeextent,

Trim the free space in the filesystem mounted on "mountpoint". The filesystem must be mounted read-write.

The filesystem contents are not affected, but any free space in the filesystem is "trimmed", that is, given back to the host device, thus making disk images more sparse, allowing unused space in qcow2 files to be reused, etc.

This operation requires support in libguestfs, the mounted filesystem, the host filesystem, qemu and the host kernel. If this support isn’t present it may give an error or even appear to run but do nothing.

In the case where the kernel vfs driver does not support trimming, this call will fail with errno set to "ENOTSUP". Currently this happens when trying to trim FAT filesystems.

See also "guestfs_zero_free_space". That is a slightly different operation that turns free space in the filesystem into zeroes. It is valid to call "guestfs_fstrim" either instead of, or after calling "guestfs_zero_free_space". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "fstrim". See also "guestfs_feature_available".

(1.19.6 に お い て 追 加 )

guestfs_fstrim_va
int
guestfs_fstrim_va (guestfs_h *g,
const char *mountpoint,
va_list args); こ れ は "guestfs_fstrim" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_fstrim_argv
int
guestfs_fstrim_argv (guestfs_h *g,
const char *mountpoint,
const struct guestfs_fstrim_argv *optargs); こ れ は "guestfs_fstrim" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_get_append
const char *
guestfs_get_append (guestfs_h *g);

Return the additional kernel options which are added to the libguestfs appliance kernel command line.

"NULL" な ら ば 、 オ プ シ ョ ン が 追 加 さ れ ま せ ん 。

This function returns a string which may be NULL. There is no way to return an error from this function. The string is owned by the guest handle and must not be freed.

(1.0.26 に お い て 追 加 )

guestfs_get_attach_method
char *
guestfs_get_attach_method (guestfs_h *g); こ の 函 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_get_backend" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

Return the current backend.

"guestfs_set_backend" お よ び "BACKEND" 参 照 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.9.8 に お い て 追 加 )

guestfs_get_autosync
int
guestfs_get_autosync (guestfs_h *g);

autosync フ ラ グ を 取 得 し ま す 。

This function returns a C truth value on success or -1 on error.

(0.3 に お い て 追 加 )

guestfs_get_backend
char *
guestfs_get_backend (guestfs_h *g);

Return the current backend.

This handle property was previously called the "attach method".

"guestfs_set_backend" お よ び "BACKEND" 参 照 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.21.26 に お い て 追 加 )

guestfs_get_backend_setting
char *
guestfs_get_backend_setting (guestfs_h *g,
const char *name);

Find a backend setting string which is either "name" or begins with "name=". If "name", this returns the string "1". If "name=", this returns the part after the equals sign (which may be an empty string).

If no such setting is found, this function throws an error. The errno (see "guestfs_last_errno") will be "ESRCH" in this case.

See "BACKEND", "BACKEND SETTINGS". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.27.2)

guestfs_get_backend_settings
char **
guestfs_get_backend_settings (guestfs_h *g);

Return the current backend settings.

This call returns all backend settings strings. If you want to find a single backend setting, see "guestfs_get_backend_setting".

See "BACKEND", "BACKEND SETTINGS".

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(Added in 1.25.24)

guestfs_get_cachedir
char *
guestfs_get_cachedir (guestfs_h *g); ア プ ラ イ ア ン ス の キ ャ ッ シ ュ を 保 存 す る た め に 、 ハ ン ド ル に よ り 使 用 さ れ る デ ィ レ ク ト リ ー を 取 得 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.58 に お い て 追 加 )

guestfs_get_direct
int
guestfs_get_direct (guestfs_h *g);

This function is deprecated. In new code, use the "guestfs_internal_get_console_socket" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

Return the direct appliance mode flag.

This function returns a C truth value on success or -1 on error.

(1.0.72 に お い て 追 加 )

guestfs_get_e2attrs
char *
guestfs_get_e2attrs (guestfs_h *g,
const char *file);

This returns the file attributes associated with file.

The attributes are a set of bits associated with each inode which affect the behaviour of the file. The attributes are returned as a string of letters (described below). The string may be empty, indicating that no file attributes are set for this file.

These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.

The characters (file attributes) in the returned string are currently:

(デ ィ レ ク ト リ ー の み 。 ) こ の デ ィ レ ク ト リ ー へ の 変 更 が デ ィ ス ク に 同 期 的 に 書 き 込 ま れ ま す 。

フ ァ イ ル は 圧 縮 エ ラ ー が あ り ま す 。

The file is storing its blocks in units of the filesystem blocksize instead of sectors.

フ ァ イ ル は ジ ャ ー ナ ル 付 き デ ー タ で す 。

(Directories only.) This is a hint to the block allocator that subdirectories contained in this directory should be spread across blocks. If not present, the block allocator will try to group subdirectories together.

圧 縮 フ ァ イ ル の 内 容 に ア ク セ ス で き ま す 。

More file attributes may be added to this list later. Not all file attributes may be set for all kinds of files. For detailed information, consult the chattr(1) man page.

"guestfs_set_e2attrs" 参 照 。

Don’t confuse these attributes with extended attributes (see "guestfs_getxattr"). こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.17.31 に お い て 追 加 )

guestfs_get_e2generation
int64_t
guestfs_get_e2generation (guestfs_h *g,
const char *file);

This returns the ext2 file generation of a file. The generation (which used to be called the "version") is a number associated with an inode. This is most commonly used by NFS servers.

The generation is only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.

"guestfs_set_e2generation" 参 照 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.17.31 に お い て 追 加 )

guestfs_get_e2label
char *
guestfs_get_e2label (guestfs_h *g,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_vfs_label" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は "device" に あ る フ ァ イ ル シ ス テ ム の ext2/3/4 フ ァ イ ル シ ス テ ム ラ ベ ル を 返 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.15 に お い て 追 加 )

guestfs_get_e2uuid
char *
guestfs_get_e2uuid (guestfs_h *g,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_vfs_uuid" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は "device" に あ る フ ァ イ ル シ ス テ ム の ext2/3/4 フ ァ イ ル シ ス テ ム UUID を 返 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.15 に お い て 追 加 )

guestfs_get_hv
char *
guestfs_get_hv (guestfs_h *g);

Return the current hypervisor binary.

This is always non-NULL. If it wasn’t set already, then this will return the default qemu binary name. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.23.17)

guestfs_get_identifier
const char *
guestfs_get_identifier (guestfs_h *g);

Get the handle identifier. See "guestfs_set_identifier".

This function returns a string, or NULL on error. The string is owned by the guest handle and must not be freed.

(Added in 1.31.14)

guestfs_get_libvirt_requested_credential_challenge
char *
guestfs_get_libvirt_requested_credential_challenge (guestfs_h *g,
int index);

Get the challenge (provided by libvirt) for the "index"’th requested credential. If libvirt did not provide a challenge, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" for documentation and example code. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.52 に お い て 追 加 ))

guestfs_get_libvirt_requested_credential_defresult
char *
guestfs_get_libvirt_requested_credential_defresult (guestfs_h *g,
int index);

Get the default result (provided by libvirt) for the "index"’th requested credential. If libvirt did not provide a default result, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" for documentation and example code. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.52 に お い て 追 加 ))

guestfs_get_libvirt_requested_credential_prompt
char *
guestfs_get_libvirt_requested_credential_prompt (guestfs_h *g,
int index);

Get the prompt (provided by libvirt) for the "index"’th requested credential. If libvirt did not provide a prompt, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" for documentation and example code. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.52 に お い て 追 加 ))

guestfs_get_libvirt_requested_credentials
char **
guestfs_get_libvirt_requested_credentials (guestfs_h *g);

This should only be called during the event callback for events of type "GUESTFS_EVENT_LIBVIRT_AUTH".

Return the list of credentials requested by libvirt. Possible values are a subset of the strings provided when you called "guestfs_set_libvirt_supported_credentials".

See "LIBVIRT AUTHENTICATION" for documentation and example code.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.19.52 に お い て 追 加 ))

guestfs_get_memsize
int
guestfs_get_memsize (guestfs_h *g);

This gets the memory size in megabytes allocated to the hypervisor.

If "guestfs_set_memsize" was not called on this handle, and if "LIBGUESTFS_MEMSIZE" was not set, then this returns the compiled-in default value for memsize.

libguestfs の ア ー キ テ ク チ ャ ー の 詳 細 は guestfs(3) を 参 照 し て く だ さ い 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.0.55 に お い て 追 加 )

guestfs_get_network
int
guestfs_get_network (guestfs_h *g); こ れ は 有 効 化 さ れ て い る ネ ッ ト ワ ー ク フ ラ グ を 返 し ま す 。

This function returns a C truth value on success or -1 on error.

(1.5.4 に お い て 追 加 )

guestfs_get_path
const char *
guestfs_get_path (guestfs_h *g); 現 在 の 検 索 パ ス を 返 し ま す 。

This is always non-NULL. If it wasn’t set already, then this will return the default path.

This function returns a string, or NULL on error. The string is owned by the guest handle and must not be freed.

(0.3 に お い て 追 加 )

guestfs_get_pgroup
int
guestfs_get_pgroup (guestfs_h *g); こ れ は プ ロ セ ス グ ル ー プ フ ラ グ を 返 し ま す 。

This function returns a C truth value on success or -1 on error.

(1.11.18 に お い て 追 加 )

guestfs_get_pid
int
guestfs_get_pid (guestfs_h *g);

Return the process ID of the hypervisor. If there is no hypervisor running, then this will return an error.

This is an internal call used for debugging and testing. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.0.56 に お い て 追 加 )

guestfs_get_program
const char *
guestfs_get_program (guestfs_h *g);

Get the program name. See "guestfs_set_program".

This function returns a string, or NULL on error. The string is owned by the guest handle and must not be freed.

(1.21.29 に お い て 追 加 )

guestfs_get_qemu
const char *
guestfs_get_qemu (guestfs_h *g);

This function is deprecated. In new code, use the "guestfs_get_hv" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

Return the current hypervisor binary (usually qemu).

This is always non-NULL. If it wasn’t set already, then this will return the default qemu binary name.

This function returns a string, or NULL on error. The string is owned by the guest handle and must not be freed.

(1.0.6 に お い て 追 加 )

guestfs_get_recovery_proc
int
guestfs_get_recovery_proc (guestfs_h *g); 復 元 プ ロ セ ス 有 効 化 フ ラ グ を 返 し ま す 。

This function returns a C truth value on success or -1 on error.

(1.0.77 に お い て 追 加 )

guestfs_get_selinux
int
guestfs_get_selinux (guestfs_h *g);

This function is deprecated. In new code, use the "guestfs_selinux_relabel" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This returns the current setting of the selinux flag which is passed to the appliance at boot time. See "guestfs_set_selinux".

libguestfs の ア ー キ テ ク チ ャ ー の 詳 細 は guestfs(3) を 参 照 し て く だ さ い 。

This function returns a C truth value on success or -1 on error.

(1.0.67 に お い て 追 加 )

guestfs_get_smp
int
guestfs_get_smp (guestfs_h *g);

This returns the number of virtual CPUs assigned to the appliance. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.13.15 に お い て 追 加 )

guestfs_get_sockdir
char *
guestfs_get_sockdir (guestfs_h *g);

Get the directory used by the handle to store temporary socket and PID files.

This is different from "guestfs_get_tmpdir", as we need shorter paths for sockets (due to the limited buffers of filenames for UNIX sockets), and "guestfs_get_tmpdir" may be too long for them. Furthermore, sockets and PID files must be accessible to such background services started by libguestfs that may not have permission to access the temporary directory returned by "guestfs_get_tmpdir".

The environment variable "XDG_RUNTIME_DIR" controls the default value: If "XDG_RUNTIME_DIR" is set, then that is the default. Else /tmp is the default. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.33.8)

guestfs_get_state
int
guestfs_get_state (guestfs_h *g);

This returns the current state as an opaque integer. This is only useful for printing debug and internal error messages.

For more information on states, see guestfs(3). こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.0.2 に お い て 追 加 )

guestfs_get_tmpdir
char *
guestfs_get_tmpdir (guestfs_h *g);

Get the directory used by the handle to store temporary files. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.58 に お い て 追 加 )

guestfs_get_trace
int
guestfs_get_trace (guestfs_h *g); コ マ ン ド ト レ ー ス フ ラ グ を 返 し ま す 。

This function returns a C truth value on success or -1 on error.

(1.0.69 に お い て 追 加 )

guestfs_get_umask
int
guestfs_get_umask (guestfs_h *g);

Return the current umask. By default the umask is 022 unless it has been set by calling "guestfs_umask". こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.3.4 に お い て 追 加 )

guestfs_get_verbose
int
guestfs_get_verbose (guestfs_h *g); こ れ は メ ッ セ ー ジ 冗 長 化 フ ラ グ を 返 し ま す 。

This function returns a C truth value on success or -1 on error.

(0.3 に お い て 追 加 )

guestfs_getcon
char *
guestfs_getcon (guestfs_h *g);

This function is deprecated. In new code, use the "guestfs_selinux_relabel" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は デ ー モ ン の SELinux セ キ ュ リ テ ィ コ ン テ キ ス ト を 取 得 し ま す 。

guestfs(3) に お け る SELinux お よ び "guestfs_setcon" に 関 す る ド キ ュ メ ン ト を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "selinux". See also "guestfs_feature_available".

(1.0.67 に お い て 追 加 )

guestfs_getxattr
char *
guestfs_getxattr (guestfs_h *g,
const char *path,
const char *name,
size_t *size_r);

Get a single extended attribute from file "path" named "name". This call follows symlinks. If you want to lookup an extended attribute for the symlink itself, use "guestfs_lgetxattr".

Normally it is better to get all extended attributes from a file in one go by calling "guestfs_getxattrs". However some Linux filesystem implementations are buggy and do not provide a way to list out attributes. For these filesystems (notably ntfs-3g) you have to know the names of the extended attributes you want in advance and call this function.

Extended attribute values are blobs of binary data. If there is no extended attribute named "name", this returns an error. 関 連 項 目 : "guestfs_getxattrs", "guestfs_lgetxattr", attr(5)

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.7.24 に お い て 追 加 )

guestfs_getxattrs
struct guestfs_xattr_list *
guestfs_getxattrs (guestfs_h *g,
const char *path);

This call lists the extended attributes of the file or directory "path".

At the system call level, this is a combination of the listxattr(2) and getxattr(2) calls. 関 連 項 目 : "guestfs_lgetxattrs", attr(5) こ の 関 数 は "struct guestfs_xattr_list *" を 返 し ま す 。 も し く は 、 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_xattr_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.59 に お い て 追 加 )

guestfs_glob_expand
char **
guestfs_glob_expand (guestfs_h *g,
const char *pattern);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_glob_expand_opts" with no optional arguments.

(1.0.50 に お い て 追 加 )

guestfs_glob_expand_opts
char **
guestfs_glob_expand_opts (guestfs_h *g,
const char *pattern,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_GLOB_EXPAND_OPTS_DIRECTORYSLASH, int directoryslash,

This command searches for all the pathnames matching "pattern" according to the wildcard expansion rules used by the shell.

If no paths match, then this returns an empty list (note: not an error).

It is just a wrapper around the C glob(3) function with flags "GLOB_MARK|GLOB_BRACE". See that manual page for more details.

"directoryslash" controls whether use the "GLOB_MARK" flag for glob(3), and it defaults to true. It can be explicitly set as off to return no trailing slashes in filenames of directories.

Notice that there is no equivalent command for expanding a device name (eg. /dev/sd*). Use "guestfs_list_devices", "guestfs_list_partitions" etc functions instead.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.0.50 に お い て 追 加 )

guestfs_glob_expand_opts_va
char **
guestfs_glob_expand_opts_va (guestfs_h *g,
const char *pattern,
va_list args);

This is the "va_list variant" of "guestfs_glob_expand_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_glob_expand_opts_argv
char **
guestfs_glob_expand_opts_argv (guestfs_h *g,
const char *pattern,
const struct guestfs_glob_expand_opts_argv *optargs);

This is the "argv variant" of "guestfs_glob_expand_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_grep
char **
guestfs_grep (guestfs_h *g,
const char *regex,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_grep_opts" with no optional arguments.

(1.0.66 に お い て 追 加 )

guestfs_grep_opts
char **
guestfs_grep_opts (guestfs_h *g,
const char *regex,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_GREP_OPTS_EXTENDED, int extended,
GUESTFS_GREP_OPTS_FIXED, int fixed,
GUESTFS_GREP_OPTS_INSENSITIVE, int insensitive,
GUESTFS_GREP_OPTS_COMPRESSED, int compressed,

This calls the external grep(1) program and returns the matching lines. オ プ シ ョ ン の フ ラ グ は 次 の と お り で す :
"extended"

Use extended regular expressions. This is the same as using the -E flag.

"fixed"

Match fixed (don’t use regular expressions). This is the same as using the -F flag.

"insensitive"

Match case-insensitive. This is the same as using the -i flag.

"compressed"

Use zgrep(1) instead of grep(1). This allows the input to be compress- or gzip-compressed.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.66 に お い て 追 加 )

guestfs_grep_opts_va
char **
guestfs_grep_opts_va (guestfs_h *g,
const char *regex,
const char *path,
va_list args); こ れ は "guestfs_grep_opts" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_grep_opts_argv
char **
guestfs_grep_opts_argv (guestfs_h *g,
const char *regex,
const char *path,
const struct guestfs_grep_opts_argv *optargs); こ れ は "guestfs_grep_opts" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_grepi
char **
guestfs_grepi (guestfs_h *g,
const char *regex,
const char *path); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_grep" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は 外 部 の "grep -i" プ ロ グ ラ ム を 呼 び 出 し 、 一 致 す る 行 を 返 し ま す 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.66 に お い て 追 加 )

guestfs_grub_install
int
guestfs_grub_install (guestfs_h *g,
const char *root,
const char *device);

This command installs GRUB 1 (the Grand Unified Bootloader) on "device", with the root directory being "root". 注 :

(hd0) /dev/vda

replacing /dev/vda with the name of the installation device. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "grub". See also "guestfs_feature_available".

(1.0.17 に お い て 追 加 )

guestfs_head
char **
guestfs_head (guestfs_h *g,
const char *path); こ の コ マ ン ド は 文 字 列 の 一 覧 と し て 、 フ ァ イ ル の 先 頭 10 行 ま で を 返 し ま す 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.54 に お い て 追 加 )

guestfs_head_n
char **
guestfs_head_n (guestfs_h *g,
int nrlines,
const char *path); パ ラ メ ー タ ー "nrlines" が 正 の 数 な ら ば 、 こ れ は フ ァ イ ル "path" の 先 頭 "nrlines" 行 を 返 し ま す 。 パ ラ メ ー タ ー "nrlines" が 負 の 数 な ら ば 、 こ れ は フ ァ イ ル "path" の 末 尾 "nrlines" 行 を 取 り 除 い た 行 を 返 し ま す 。 パ ラ メ ー タ ー "nrlines" が 0 な ら ば 、 空 の 一 覧 を 返 し ま す 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.54 に お い て 追 加 )

guestfs_hexdump
char *
guestfs_hexdump (guestfs_h *g,
const char *path); 指 定 さ れ た "path" に お い て "hexdump -C" を 実 行 し ま す 。 結 果 は 、 読 み や す い 形 式 に な り 、 フ ァ イ ル の 正 規 化 さ れ た 16 進 ダ ン プ で す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.22 に お い て 追 加 )

guestfs_hivex_close
int
guestfs_hivex_close (guestfs_h *g); 現 在 の hivex ハ ン ド ル を 閉 じ ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_commit
int
guestfs_hivex_commit (guestfs_h *g,
const char *filename); ハ イ ブ へ の 変 更 を コ ミ ッ ト （ 書 き 込 み ） し ま す 。

If the optional filename parameter is null, then the changes are written back to the same hive that was opened. If this is not null then they are written to the alternate filename given and the original hive is left untouched. こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_add_child
int64_t
guestfs_hivex_node_add_child (guestfs_h *g,
int64_t parent,
const char *name); 子 ノ ー ド に "name" と い う 名 前 の "parent" を 追 加 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_children
struct guestfs_hivex_node_list *
guestfs_hivex_node_children (guestfs_h *g,
int64_t nodeh);

"nodeh" の サ ブ キ ー で あ る ノ ー ド の 一 覧 を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は "struct guestfs_hivex_node_list *" を 返 し ま す 。 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 し た 後 に "guestfs_free_hivex_node_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_delete_child
int
guestfs_hivex_node_delete_child (guestfs_h *g,
int64_t nodeh);

"nodeh" を 削 除 し ま す 。 必 要 に 応 じ て 、 再 帰 的 に 削 除 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_get_child
int64_t
guestfs_hivex_node_get_child (guestfs_h *g,
int64_t nodeh,
const char *name);

Return the child of "nodeh" with the name "name", if it exists. This can return 0 meaning the name was not found. こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_get_value
int64_t
guestfs_hivex_node_get_value (guestfs_h *g,
int64_t nodeh,
const char *key);

Return the value attached to "nodeh" which has the name "key", if it exists. This can return 0 meaning the key was not found. こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_name
char *
guestfs_hivex_node_name (guestfs_h *g,
int64_t nodeh);

"nodeh" の 名 前 を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_parent
int64_t
guestfs_hivex_node_parent (guestfs_h *g,
int64_t nodeh);

"nodeh" の 親 ノ ー ド を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_set_value
int
guestfs_hivex_node_set_value (guestfs_h *g,
int64_t nodeh,
const char *key,
int64_t t,
const char *val,
size_t val_size);

Set or replace a single value under the node "nodeh". The "key" is the name, "t" is the type, and "val" is the data. こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_node_values
struct guestfs_hivex_value_list *
guestfs_hivex_node_values (guestfs_h *g,
int64_t nodeh);

Return the array of (key, datatype, data) tuples attached to "nodeh". こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は "struct guestfs_hivex_value_list *" を 返 し ま す 。 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 し た 後 に "guestfs_free_hivex_value_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_open
int
guestfs_hivex_open (guestfs_h *g,
const char *filename,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_HIVEX_OPEN_VERBOSE, int verbose,
GUESTFS_HIVEX_OPEN_DEBUG, int debug,
GUESTFS_HIVEX_OPEN_WRITE, int write,
GUESTFS_HIVEX_OPEN_UNSAFE, int unsafe,

Open the Windows Registry hive file named filename. If there was any previous hivex handle associated with this guestfs session, then it is closed. こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_open_va
int
guestfs_hivex_open_va (guestfs_h *g,
const char *filename,
va_list args); こ れ は "guestfs_hivex_open" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_hivex_open_argv
int
guestfs_hivex_open_argv (guestfs_h *g,
const char *filename,
const struct guestfs_hivex_open_argv *optargs); こ れ は "guestfs_hivex_open" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_hivex_root
int64_t
guestfs_hivex_root (guestfs_h *g); ハ イ ブ の ル ー ト ノ ー ド を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_value_key
char *
guestfs_hivex_value_key (guestfs_h *g,
int64_t valueh);

(key, datatype, data) 組 の キ ー (name) 項 目 を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_value_string
char *
guestfs_hivex_value_string (guestfs_h *g,
int64_t valueh);

This calls "guestfs_hivex_value_value" (which returns the data field from a hivex value tuple). It then assumes that the field is a UTF-16LE string and converts the result to UTF-8 (or if this is not possible, it returns an error).

This is useful for reading strings out of the Windows registry. However it is not foolproof because the registry is not strongly-typed and fields can contain arbitrary or unexpected data. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(Added in 1.37.22)

guestfs_hivex_value_type
int64_t
guestfs_hivex_value_type (guestfs_h *g,
int64_t valueh);

(key, datatype, data) 組 の datatype 項 目 を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_value_utf8
char *
guestfs_hivex_value_utf8 (guestfs_h *g,
int64_t valueh);

This function is deprecated. In new code, use the "guestfs_hivex_value_string" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This calls "guestfs_hivex_value_value" (which returns the data field from a hivex value tuple). It then assumes that the field is a UTF-16LE string and converts the result to UTF-8 (or if this is not possible, it returns an error).

This is useful for reading strings out of the Windows registry. However it is not foolproof because the registry is not strongly-typed and fields can contain arbitrary or unexpected data. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_hivex_value_value
char *
guestfs_hivex_value_value (guestfs_h *g,
int64_t valueh,
size_t *size_r);

(key, datatype, data) 組 の デ ー タ 項 目 を 返 し ま す 。 こ れ は 同 じ 名 前 の hivex(3) の ラ ッ パ ー で す 。 関 連 項 目 : "guestfs_hivex_value_utf8"。

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

This function depends on the feature "hivex". See also "guestfs_feature_available".

(1.19.35 に お い て 追 加 )

guestfs_initrd_cat
char *
guestfs_initrd_cat (guestfs_h *g,
const char *initrdpath,
const char *filename,
size_t *size_r);

This command unpacks the file filename from the initrd file called initrdpath. The filename must be given without the initial / character.

For example, in guestfish you could use the following command to examine the boot script (usually called /init) contained in a Linux initrd or initramfs image:

initrd-cat /boot/initrd-<version>.img init

"guestfs_initrd_list" 参 照 。

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.84 に お い て 追 加 )

guestfs_initrd_list
char **
guestfs_initrd_list (guestfs_h *g,
const char *path); こ の コ マ ン ド は initrd に 含 ま れ る フ ァ イ ル を 一 覧 表 示 し ま す 。

The files are listed without any initial / character. The files are listed in the order they appear (not necessarily alphabetical). Directory names are listed as separate items. 古 い Linux カ ー ネ ル (2.4 お よ び そ れ 以 前 ) は initrd と し て 圧 縮 ext2 フ ァ イ ル シ ス テ ム を 使 用 し て い ま し た 。 新 し い initramfs 形 式 (圧 縮 cpio フ ァ イ ル ) の み を サ ポ ー ト し ま す 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.0.54 に お い て 追 加 )

guestfs_inotify_add_watch
int64_t
guestfs_inotify_add_watch (guestfs_h *g,
const char *path,
int mask);

"mask" に 一 覧 化 さ れ た イ ベ ン ト に 対 し て "path" を 監 視 し ま す 。

Note that if "path" is a directory then events within that directory are watched, but this does not happen recursively (in subdirectories).

Note for non-C or non-Linux callers: the inotify events are defined by the Linux kernel ABI and are listed in /usr/include/sys/inotify.h. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inotify_close
int
guestfs_inotify_close (guestfs_h *g);

This closes the inotify handle which was previously opened by inotify_init. It removes all watches, throws away any pending events, and deallocates all resources. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inotify_files
char **
guestfs_inotify_files (guestfs_h *g);

This function is a helpful wrapper around "guestfs_inotify_read" which just returns a list of pathnames of objects that were touched. The returned pathnames are sorted and deduplicated.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inotify_init
int
guestfs_inotify_init (guestfs_h *g,
int maxevents);

This command creates a new inotify handle. The inotify subsystem can be used to notify events which happen to objects in the guest filesystem.

"maxevents" is the maximum number of events which will be queued up between calls to "guestfs_inotify_read" or "guestfs_inotify_files". If this is passed as 0, then the kernel (or previously set) default is used. For Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel throws away events, but records the fact that it threw them away by setting a flag "IN_Q_OVERFLOW" in the returned structure list (see "guestfs_inotify_read"). 何 ら か の イ ベ ン ト を 生 成 す る 前 に 、 い く つ か の ウ ォ ッ チ と 内 部 ウ ォ ッ チ リ ス ト に 追 加 す る 必 要 が あ り ま す 。 参 照 : "guestfs_inotify_add_watch" お よ び "guestfs_inotify_rm_watch"。

Queued up events should be read periodically by calling "guestfs_inotify_read" (or "guestfs_inotify_files" which is just a helpful wrapper around "guestfs_inotify_read"). If you don’t read the events out often enough then you risk the internal queue overflowing.

The handle should be closed after use by calling "guestfs_inotify_close". This also removes any watches automatically.

See also inotify(7) for an overview of the inotify interface as exposed by the Linux kernel, which is roughly what we expose via libguestfs. Note that there is one global inotify handle per libguestfs instance. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inotify_read
struct guestfs_inotify_event_list *
guestfs_inotify_read (guestfs_h *g);

Return the complete queue of events that have happened since the previous read call. 何 も イ ベ ン ト が 起 き な い と 、 こ れ は 空 の 一 覧 を 返 し ま す 。

Note: In order to make sure that all events have been read, you must call this function repeatedly until it returns an empty list. The reason is that the call will read events up to the maximum appliance-to-host message size and leave remaining events in the queue.

This function returns a "struct guestfs_inotify_event_list *", or NULL if there was an error. The caller must call "guestfs_free_inotify_event_list" after use.

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inotify_rm_watch
int
guestfs_inotify_rm_watch (guestfs_h *g,
int wd); 前 に 定 義 さ れ た inotify ウ ォ ッ チ を 削 除 し ま す 。 "guestfs_inotify_add_watch" 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "inotify". See also "guestfs_feature_available".

(1.0.66 に お い て 追 加 )

guestfs_inspect_get_arch
char *
guestfs_inspect_get_arch (guestfs_h *g,
const char *root); こ れ は 検 査 し た オ ペ レ ー テ ィ ン グ シ ス テ ム の ア ー キ テ ク チ ャ ー を 返 し ま す 。 と り う る 値 は "guestfs_file_architecture" の 下 に 一 覧 化 さ れ て い ま す 。 ア ー キ テ ク チ ャ ー が 決 め ら れ な け れ ば 、 文 字 列 "unknown" が 返 さ れ ま す 。 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_build_id
char *
guestfs_inspect_get_build_id (guestfs_h *g,
const char *root);

This returns the build ID of the system, or the string "unknown" if the system does not have a build ID.

For Windows, this gets the build number. Although it is returned as a string, it is (so far) always a number. See https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions for some possible values.

For Linux, this returns the "BUILD_ID" string from /etc/os-release, although this is not often used. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.49.8)

guestfs_inspect_get_distro
char *
guestfs_inspect_get_distro (guestfs_h *g,
const char *root); こ れ は 検 査 し た オ ペ レ ー テ ィ ン グ シ ス テ ム の デ ィ ス ト リ ビ ュ ー シ ョ ン を 返 し ま す 。 定 義 さ れ て い る デ ィ ス ト リ ビ ュ ー シ ョ ン は 現 在 次 の と お り で す :
"alpinelinux"

Alpine Linux.

"altlinux"

ALT Linux.

"archlinux"

Arch Linux.

"buildroot"

Buildroot 派 生 の デ ィ ス ト リ ビ ュ ー シ ョ ン . 具 体 的 に ど れ か を 認 識 し ま せ ん .

"centos"

CentOS.

"cirros"

Cirros.

"coreos"

CoreOS.

"debian"

Debian.

"fedora"

Fedora.

"freebsd"

FreeBSD.

"freedos"

FreeDOS.

"frugalware"

Frugalware.

"gentoo"

Gentoo.

"kalilinux"

Kali Linux.

"kylin"

Kylin.

"linuxmint"

Linux Mint.

"mageia"

Mageia.

"mandriva"

Mandriva.

"meego"

MeeGo.

"msdos"

Microsoft DOS.

"neokylin"

NeoKylin.

"netbsd"

NetBSD.

"openbsd"

OpenBSD.

"openmandriva"

OpenMandriva Lx.

"opensuse"

OpenSUSE.

"oraclelinux"

Oracle Linux.

"pardus"

Pardus.

"pldlinux"

PLD Linux.

"redhat-based" い く つ か の Red Hat 派 生 デ ィ ス ト リ ビ ュ ー シ ョ ン .
"rhel"

Red Hat Enterprise Linux.

"rocky"

Rocky Linux.

"scientificlinux"

Scientific Linux.

"slackware"

Slackware.

"sles"

SuSE Linux Enterprise Server ま た は Desktop.

"suse-based" い く つ か の openSuSE 派 生 デ ィ ス ト リ ビ ュ ー シ ョ ン .
"ttylinux"

ttylinux.

"ubuntu"

Ubuntu.

"unknown" デ ィ ス ト リ ビ ュ ー シ ョ ン が わ か り ま せ ん で し た 。
"voidlinux"

Void Linux.

"windows"

Windows は デ ィ ス ト リ ビ ュ ー シ ョ ン が あ り ま せ ん 。 OS 種 別 が Windows な ら ば 、 こ の 文 字 列 は 返 さ れ ま せ ん 。

libguestfs の 将 来 の バ ー ジ ョ ン は 、 こ こ に 他 の 文 字 列 を 返 す 可 能 性 が あ り ま す 。 呼 び 出 し 元 は あ ら ゆ る 文 字 列 の 処 理 に 備 え な け れ ば い け ま せ ん 。 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_drive_mappings
char **
guestfs_inspect_get_drive_mappings (guestfs_h *g,
const char *root);

This call is useful for Windows which uses a primitive system of assigning drive letters (like C:\) to partitions. This inspection API examines the Windows Registry to find out how disks/partitions are mapped to drive letters, and returns a hash table as in the example below:

C => /dev/vda2
E => /dev/vdb1
F => /dev/vdc1

Note that keys are drive letters. For Windows, the key is case insensitive and just contains the drive letter, without the customary colon separator character.

In future we may support other operating systems that also used drive letters, but the keys for those might not be case insensitive and might be longer than 1 character. For example in OS-9, hard drives were named "h0", "h1" etc.

For Windows guests, currently only hard drive mappings are returned. Removable disks (eg. DVD-ROMs) are ignored.

For guests that do not use drive mappings, or if the drive mappings could not be determined, this returns an empty hash table. 詳 細 は "INSPECTION" を 確 認 し て く だ さ い 。 合 わ せ て "guestfs_inspect_get_mountpoints", "guestfs_inspect_get_filesystems" を 参 照 し て く だ さ い 。

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

(1.9.17 に お い て 追 加 )

guestfs_inspect_get_filesystems
char **
guestfs_inspect_get_filesystems (guestfs_h *g,
const char *root);

This returns a list of all the filesystems that we think are associated with this operating system. This includes the root filesystem, other ordinary filesystems, and non-mounted devices like swap partitions.

In the case of a multi-boot virtual machine, it is possible for a filesystem to be shared between operating systems. 詳 細 は "INSPECTION" を 読 ん で く だ さ い 。 "guestfs_inspect_get_mountpoints" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_format
char *
guestfs_inspect_get_format (guestfs_h *g,
const char *root);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

Before libguestfs 1.38, there was some unreliable support for detecting installer CDs. This API would return:
"installed" イ ン ス ト ー ル さ れ て い る オ ペ レ ー テ ィ ン グ シ ス テ ム で す 。
"installer" 検 査 さ れ る デ ィ ス ク イ メ ー ジ が 、 イ ン ス ト ー ル さ れ た オ ペ レ ー テ ィ ン グ ・ シ ス テ ム で は な く 、 ブ ー ト 可 能 な イ ン ス ト ー ル デ ィ ス ク 、 ラ イ ブ CD、 ま た は 似 た よ う な も の で す 。
"unknown" こ の デ ィ ス ク イ メ ー ジ の 形 式 は 不 明 で す 。

In libguestfs ≥ 1.38, this only returns "installed". Use libosinfo directly to detect installer CDs. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.9.4 に お い て 追 加 )

guestfs_inspect_get_hostname
char *
guestfs_inspect_get_hostname (guestfs_h *g,
const char *root);

This function returns the hostname of the operating system as found by inspection of the guest’s configuration files.

If the hostname could not be determined, then the string "unknown" is returned. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.7.9 に お い て 追 加 )

guestfs_inspect_get_icon
char *
guestfs_inspect_get_icon (guestfs_h *g,
const char *root,
size_t *size_r,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,
GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,

This function returns an icon corresponding to the inspected operating system. The icon is returned as a buffer containing a PNG image (re-encoded to PNG if necessary).

If it was not possible to get an icon this function returns a zero-length (non-NULL) buffer. Callers must check for this case.

Libguestfs will start by looking for a file called /etc/favicon.png or C:\etc\favicon.png and if it has the correct format, the contents of this file will be returned. You can disable favicons by passing the optional "favicon" boolean as false (default is true).

If finding the favicon fails, then we look in other places in the guest for a suitable icon.

If the optional "highquality" boolean is true then only high quality icons are returned, which means only icons of high resolution with an alpha channel. The default (false) is to return any icon we can, even if it is of substandard quality. 注 :

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

(1.11.12 に お い て 追 加 )

guestfs_inspect_get_icon_va
char *
guestfs_inspect_get_icon_va (guestfs_h *g,
const char *root,
size_t *size_r,
va_list args); こ れ は "guestfs_inspect_get_icon" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_inspect_get_icon_argv
char *
guestfs_inspect_get_icon_argv (guestfs_h *g,
const char *root,
size_t *size_r,
const struct guestfs_inspect_get_icon_argv *optargs); こ れ は "guestfs_inspect_get_icon" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_inspect_get_major_version
int
guestfs_inspect_get_major_version (guestfs_h *g,
const char *root);

This returns the major version number of the inspected operating system.

Windows uses a consistent versioning scheme which is not reflected in the popular public names used by the operating system. Notably the operating system known as "Windows 7" is really version 6.1 (ie. major = 6, minor = 1). You can find out the real versions corresponding to releases of Windows by consulting Wikipedia or MSDN.

If the version could not be determined, then 0 is returned. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_minor_version
int
guestfs_inspect_get_minor_version (guestfs_h *g,
const char *root); 検 査 す る オ ペ レ ー テ ィ ン グ シ ス テ ム の マ イ ナ ー バ ー ジ ョ ン 番 号 を 返 し ま す 。

If the version could not be determined, then 0 is returned. 詳 細 は "INSPECTION" を 読 ん で く だ さ い 。 "guestfs_inspect_get_major_version" 参 照 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_mountpoints
char **
guestfs_inspect_get_mountpoints (guestfs_h *g,
const char *root);

This returns a hash of where we think the filesystems associated with this operating system should be mounted. Callers should note that this is at best an educated guess made by reading configuration files such as /etc/fstab. In particular note that this may return filesystems which are non-existent or not mountable and callers should be prepared to handle or ignore failures if they try to mount them.

Each element in the returned hashtable has a key which is the path of the mountpoint (eg. /boot) and a value which is the filesystem that would be mounted there (eg. /dev/sda1).

Non-mounted devices such as swap devices are not returned in this list.

For operating systems like Windows which still use drive letters, this call will only return an entry for the first drive "mounted on" /. For information about the mapping of drive letters to partitions, see "guestfs_inspect_get_drive_mappings". 詳 細 は "INSPECTION" を 読 ん で く だ さ い 。 "guestfs_inspect_get_filesystems" 参 照 。

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_osinfo
char *
guestfs_inspect_get_osinfo (guestfs_h *g,
const char *root);

This function returns a possible short ID for libosinfo corresponding to the guest.

Note: The returned ID is only a guess by libguestfs, and nothing ensures that it actually exists in osinfo-db.

If no ID could not be determined, then the string "unknown" is returned. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.39.1)

guestfs_inspect_get_package_format
char *
guestfs_inspect_get_package_format (guestfs_h *g,
const char *root);

This function and "guestfs_inspect_get_package_management" return the package format and package management tool used by the inspected operating system. For example for Fedora these functions would return "rpm" (package format), and "yum" or "dnf" (package management).

This returns the string "unknown" if we could not determine the package format or if the operating system does not have a real packaging system (eg. Windows).

Possible strings include: "rpm", "deb", "ebuild", "pisi", "pacman", "pkgsrc", "apk", "xbps". Future versions of libguestfs may return other strings. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.7.5 に お い て 追 加 )

guestfs_inspect_get_package_management
char *
guestfs_inspect_get_package_management (guestfs_h *g,
const char *root);

"guestfs_inspect_get_package_format" and this function return the package format and package management tool used by the inspected operating system. For example for Fedora these functions would return "rpm" (package format), and "yum" or "dnf" (package management).

This returns the string "unknown" if we could not determine the package management tool or if the operating system does not have a real packaging system (eg. Windows).

Possible strings include: "yum", "dnf", "up2date", "apt" (for all Debian derivatives), "portage", "pisi", "pacman", "urpmi", "zypper", "apk", "xbps". Future versions of libguestfs may return other strings. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.7.5 に お い て 追 加 )

guestfs_inspect_get_product_name
char *
guestfs_inspect_get_product_name (guestfs_h *g,
const char *root);

This returns the product name of the inspected operating system. The product name is generally some freeform string which can be displayed to the user, but should not be parsed by programs.

If the product name could not be determined, then the string "unknown" is returned. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_product_variant
char *
guestfs_inspect_get_product_variant (guestfs_h *g,
const char *root);

This returns the product variant of the inspected operating system.

For Windows guests, this returns the contents of the Registry key "HKLM\Software\Microsoft\Windows NT\CurrentVersion" "InstallationType" which is usually a string such as "Client" or "Server" (other values are possible). This can be used to distinguish consumer and enterprise versions of Windows that have the same version number (for example, Windows 7 and Windows 2008 Server are both version 6.1, but the former is "Client" and the latter is "Server").

For enterprise Linux guests, in future we intend this to return the product variant such as "Desktop", "Server" and so on. But this is not implemented at present.

If the product variant could not be determined, then the string "unknown" is returned. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 "guestfs_inspect_get_product_name", "guestfs_inspect_get_major_version" も 合 わ せ て 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.9.13 に お い て 追 加 )

guestfs_inspect_get_roots
char **
guestfs_inspect_get_roots (guestfs_h *g);

This function is a convenient way to get the list of root devices, as returned from a previous call to "guestfs_inspect_os", but without redoing the whole inspection process.

This returns an empty list if either no root devices were found or the caller has not called "guestfs_inspect_os". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.7.3 に お い て 追 加 )

guestfs_inspect_get_type
char *
guestfs_inspect_get_type (guestfs_h *g,
const char *root);

This returns the type of the inspected operating system. Currently defined types are:
"linux" す べ て の Linux ベ ー ス の オ ペ レ ー テ ィ ン グ シ ス テ ム .
"windows" す べ て の Microsoft Windows オ ペ レ ー テ ィ ン グ シ ス テ ム .
"freebsd"

FreeBSD.

"netbsd"

NetBSD.

"openbsd"

OpenBSD.

"hurd"

GNU/Hurd.

"dos"

MS-DOS, FreeDOS お よ び そ の 他 .

"minix"

MINIX.

"unknown" オ ペ レ ー テ ィ ン グ ・ シ ス テ ム の 種 類 が わ か り ま せ ん で し た 。

libguestfs の 将 来 の バ ー ジ ョ ン は 、 こ こ に 他 の 文 字 列 を 返 す 可 能 性 が あ り ま す 。 呼 び 出 し 元 は あ ら ゆ る 文 字 列 の 処 理 に 備 え な け れ ば い け ま せ ん 。 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.3 に お い て 追 加 )

guestfs_inspect_get_windows_current_control_set
char *
guestfs_inspect_get_windows_current_control_set (guestfs_h *g,
const char *root); こ れ は 検 査 し た 仮 想 マ シ ン の Windows CurrentControlSet を 返 し ま す 。 CurrentControlSet は "ControlSet001" の よ う な レ ジ ス ト リ キ ー の 名 前 で す 。 こ の 呼 び 出 し は 、 仮 想 マ シ ン が Windows で あ り 、 レ ジ ス ト リ が 検 査 に よ り 確 認 で き る こ と を 仮 定 し て い ま す 。 該 当 し な い 場 合 、 エ ラ ー が 返 さ れ ま す 。 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.9.17 に お い て 追 加 )

guestfs_inspect_get_windows_software_hive
char *
guestfs_inspect_get_windows_software_hive (guestfs_h *g,
const char *root);

This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SOFTWARE.

This call assumes that the guest is Windows and that the guest has a software hive file with the right name. If this is not the case then an error is returned. This call does not check that the hive is a valid Windows Registry hive.

You can use "guestfs_hivex_open" to read or write to the hive. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.35.26)

guestfs_inspect_get_windows_system_hive
char *
guestfs_inspect_get_windows_system_hive (guestfs_h *g,
const char *root);

This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SYSTEM.

This call assumes that the guest is Windows and that the guest has a system hive file with the right name. If this is not the case then an error is returned. This call does not check that the hive is a valid Windows Registry hive.

You can use "guestfs_hivex_open" to read or write to the hive. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.35.26)

guestfs_inspect_get_windows_systemroot
char *
guestfs_inspect_get_windows_systemroot (guestfs_h *g,
const char *root);

This returns the Windows systemroot of the inspected guest. The systemroot is a directory path such as /WINDOWS.

This call assumes that the guest is Windows and that the systemroot could be determined by inspection. If this is not the case then an error is returned. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.25 に お い て 追 加 )

guestfs_inspect_is_live
int
guestfs_inspect_is_live (guestfs_h *g,
const char *root);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This is deprecated and always returns "false". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a C truth value on success or -1 on error.

(1.9.4 に お い て 追 加 )

guestfs_inspect_is_multipart
int
guestfs_inspect_is_multipart (guestfs_h *g,
const char *root);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This is deprecated and always returns "false". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a C truth value on success or -1 on error.

(1.9.4 に お い て 追 加 )

guestfs_inspect_is_netinst
int
guestfs_inspect_is_netinst (guestfs_h *g,
const char *root);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This is deprecated and always returns "false". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a C truth value on success or -1 on error.

(1.9.4 に お い て 追 加 )

guestfs_inspect_list_applications
struct guestfs_application_list *
guestfs_inspect_list_applications (guestfs_h *g,
const char *root);

This function is deprecated. In new code, use the "guestfs_inspect_list_applications2" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

Return the list of applications installed in the operating system.

Note: This call works differently from other parts of the inspection API. You have to call "guestfs_inspect_os", then "guestfs_inspect_get_mountpoints", then mount up the disks, before calling this. Listing applications is a significantly more difficult operation which requires access to the full filesystem. Also note that unlike the other "guestfs_inspect_get_*" calls which are just returning data cached in the libguestfs handle, this call actually reads parts of the mounted filesystems during the call.

This returns an empty list if the inspection code was not able to determine the list of applications.

The application structure contains the following fields:
"app_name"

The name of the application. For Linux guests, this is the package name.

"app_display_name"

The display name of the application, sometimes localized to the install language of the guest operating system.

If unavailable this is returned as an empty string "". Callers needing to display something can use "app_name" instead.

"app_epoch"

For package managers which use epochs, this contains the epoch of the package (an integer). If unavailable, this is returned as 0.

"app_version"

The version string of the application or package. If unavailable this is returned as an empty string "".

"app_release"

The release string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app_install_path"

The installation path of the application (on operating systems such as Windows which use installation paths). This path is in the format used by the guest operating system, it is not a libguestfs path.

If unavailable this is returned as an empty string "".

"app_trans_path"

The install path translated into a libguestfs path. If unavailable this is returned as an empty string "".

"app_publisher"

The name of the publisher of the application, for package managers that use this. If unavailable this is returned as an empty string "".

"app_url"

The URL (eg. upstream URL) of the application. If unavailable this is returned as an empty string "".

"app_source_package"

For packaging systems which support this, the name of the source package. If unavailable this is returned as an empty string "".

"app_summary"

A short (usually one line) description of the application or package. If unavailable this is returned as an empty string "".

"app_description"

A longer description of the application or package. If unavailable this is returned as an empty string "". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a "struct guestfs_application_list *", or NULL if there was an error. The caller must call "guestfs_free_application_list" after use.

(1.7.8 に お い て 追 加 )

guestfs_inspect_list_applications2
struct guestfs_application2_list *
guestfs_inspect_list_applications2 (guestfs_h *g,
const char *root);

Return the list of applications installed in the operating system.

Note: This call works differently from other parts of the inspection API. You have to call "guestfs_inspect_os", then "guestfs_inspect_get_mountpoints", then mount up the disks, before calling this. Listing applications is a significantly more difficult operation which requires access to the full filesystem. Also note that unlike the other "guestfs_inspect_get_*" calls which are just returning data cached in the libguestfs handle, this call actually reads parts of the mounted filesystems during the call.

This returns an empty list if the inspection code was not able to determine the list of applications.

The application structure contains the following fields:
"app2_name"

The name of the application. For Linux guests, this is the package name.

"app2_display_name"

The display name of the application, sometimes localized to the install language of the guest operating system.

If unavailable this is returned as an empty string "". Callers needing to display something can use "app2_name" instead.

"app2_epoch"

For package managers which use epochs, this contains the epoch of the package (an integer). If unavailable, this is returned as 0.

"app2_version"

The version string of the application or package. If unavailable this is returned as an empty string "".

"app2_release"

The release string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_arch"

The architecture string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_install_path"

The installation path of the application (on operating systems such as Windows which use installation paths). This path is in the format used by the guest operating system, it is not a libguestfs path.

If unavailable this is returned as an empty string "".

"app2_trans_path"

The install path translated into a libguestfs path. If unavailable this is returned as an empty string "".

"app2_publisher"

The name of the publisher of the application, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_url"

The URL (eg. upstream URL) of the application. If unavailable this is returned as an empty string "".

"app2_source_package"

For packaging systems which support this, the name of the source package. If unavailable this is returned as an empty string "".

"app2_summary"

A short (usually one line) description of the application or package. If unavailable this is returned as an empty string "".

"app2_description"

A longer description of the application or package. If unavailable this is returned as an empty string "". 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

This function returns a "struct guestfs_application2_list *", or NULL if there was an error. The caller must call "guestfs_free_application2_list" after use.

(1.19.56 に お い て 追 加 )

guestfs_inspect_os
char **
guestfs_inspect_os (guestfs_h *g);

This function uses other libguestfs functions and certain heuristics to inspect the disk(s) (usually disks belonging to a virtual machine), looking for operating systems.

The list returned is empty if no operating systems were found.

If one operating system was found, then this returns a list with a single element, which is the name of the root filesystem of this operating system. It is also possible for this function to return a list containing more than one element, indicating a dual-boot or multi-boot virtual machine, with each element being the root filesystem of one of the operating systems.

You can pass the root string(s) returned to other "guestfs_inspect_get_*" functions in order to query further information about each operating system, such as the name and version.

This function uses other libguestfs features such as "guestfs_mount_ro" and "guestfs_umount_all" in order to mount and unmount filesystems and look at the contents. This should be called with no disks currently mounted. The function may also use Augeas, so any existing Augeas handle will be closed.

This function cannot decrypt encrypted disks. The caller must do that first (supplying the necessary keys) if the disk is encrypted. 詳 細 は "INSPECTION" を 参 照 し て く だ さ い 。

"guestfs_list_filesystems" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.5.3 に お い て 追 加 )

guestfs_is_blockdev
int
guestfs_is_blockdev (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_blockdev_opts" with no optional arguments.

(1.5.10 に お い て 追 加 )

guestfs_is_blockdev_opts
int
guestfs_is_blockdev_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_BLOCKDEV_OPTS_FOLLOWSYMLINKS, int followsymlinks, 与 え ら れ た "パ ス "名 を 持 つ ブ ロ ッ ク デ バ イ ス が あ れ ば 、 "真 "を 返 し ま す 。

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a block device also causes the function to return true.

This call only looks at files within the guest filesystem. Libguestfs partitions and block devices (eg. /dev/sda) cannot be used as the "path" parameter of this call.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.5.10 に お い て 追 加 )

guestfs_is_blockdev_opts_va
int
guestfs_is_blockdev_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_blockdev_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_blockdev_opts_argv
int
guestfs_is_blockdev_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_blockdev_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_blockdev_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_busy
int
guestfs_is_busy (guestfs_h *g);

This always returns false. This function is deprecated with no replacement. Do not use this function.

For more information on states, see guestfs(3).

This function returns a C truth value on success or -1 on error.

(1.0.2 に お い て 追 加 )

guestfs_is_chardev
int
guestfs_is_chardev (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_chardev_opts" with no optional arguments.

(1.5.10 に お い て 追 加 )

guestfs_is_chardev_opts
int
guestfs_is_chardev_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_CHARDEV_OPTS_FOLLOWSYMLINKS, int followsymlinks,

This returns "true" if and only if there is a character device with the given "path" name.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a chardev also causes the function to return true.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.5.10 に お い て 追 加 )

guestfs_is_chardev_opts_va
int
guestfs_is_chardev_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_chardev_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_chardev_opts_argv
int
guestfs_is_chardev_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_chardev_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_chardev_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_config
int
guestfs_is_config (guestfs_h *g);

This returns true iff this handle is being configured (in the "CONFIG" state).

For more information on states, see guestfs(3).

This function returns a C truth value on success or -1 on error.

(1.0.2 に お い て 追 加 )

guestfs_is_dir
int
guestfs_is_dir (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_dir_opts" with no optional arguments.

(0.8 に お い て 追 加 )

guestfs_is_dir_opts
int
guestfs_is_dir_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_DIR_OPTS_FOLLOWSYMLINKS, int followsymlinks,

This returns "true" if and only if there is a directory with the given "path" name. Note that it returns false for other objects like files.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a directory also causes the function to return true.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(0.8 に お い て 追 加 )

guestfs_is_dir_opts_va
int
guestfs_is_dir_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_dir_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_dir_opts_argv
int
guestfs_is_dir_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_dir_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_dir_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_fifo
int
guestfs_is_fifo (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_fifo_opts" with no optional arguments.

(1.5.10 に お い て 追 加 )

guestfs_is_fifo_opts
int
guestfs_is_fifo_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_FIFO_OPTS_FOLLOWSYMLINKS, int followsymlinks,

This returns "true" if and only if there is a FIFO (named pipe) with the given "path" name.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a FIFO also causes the function to return true.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.5.10 に お い て 追 加 )

guestfs_is_fifo_opts_va
int
guestfs_is_fifo_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_fifo_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_fifo_opts_argv
int
guestfs_is_fifo_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_fifo_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_fifo_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_file
int
guestfs_is_file (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_file_opts" with no optional arguments.

(0.8 に お い て 追 加 )

guestfs_is_file_opts
int
guestfs_is_file_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_FILE_OPTS_FOLLOWSYMLINKS, int followsymlinks,

This returns "true" if and only if there is a regular file with the given "path" name. Note that it returns false for other objects like directories.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a file also causes the function to return true.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(0.8 に お い て 追 加 )

guestfs_is_file_opts_va
int
guestfs_is_file_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_file_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_file_opts_argv
int
guestfs_is_file_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_file_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_file_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_launching
int
guestfs_is_launching (guestfs_h *g);

This returns true iff this handle is launching the subprocess (in the "LAUNCHING" state).

For more information on states, see guestfs(3).

This function returns a C truth value on success or -1 on error.

(1.0.2 に お い て 追 加 )

guestfs_is_lv
int
guestfs_is_lv (guestfs_h *g,
const char *mountable);

This command tests whether "mountable" is a logical volume, and returns true iff this is the case.

This function returns a C truth value on success or -1 on error.

(1.5.3 に お い て 追 加 )

guestfs_is_ready
int
guestfs_is_ready (guestfs_h *g);

This returns true iff this handle is ready to accept commands (in the "READY" state).

For more information on states, see guestfs(3).

This function returns a C truth value on success or -1 on error.

(1.0.2 に お い て 追 加 )

guestfs_is_socket
int
guestfs_is_socket (guestfs_h *g,
const char *path);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_is_socket_opts" with no optional arguments.

(1.5.10 に お い て 追 加 )

guestfs_is_socket_opts
int
guestfs_is_socket_opts (guestfs_h *g,
const char *path,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_IS_SOCKET_OPTS_FOLLOWSYMLINKS, int followsymlinks,

This returns "true" if and only if there is a Unix domain socket with the given "path" name.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a socket also causes the function to return true.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.5.10 に お い て 追 加 )

guestfs_is_socket_opts_va
int
guestfs_is_socket_opts_va (guestfs_h *g,
const char *path,
va_list args);

This is the "va_list variant" of "guestfs_is_socket_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_socket_opts_argv
int
guestfs_is_socket_opts_argv (guestfs_h *g,
const char *path,
const struct guestfs_is_socket_opts_argv *optargs);

This is the "argv variant" of "guestfs_is_socket_opts".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_is_symlink
int
guestfs_is_symlink (guestfs_h *g,
const char *path);

This returns "true" if and only if there is a symbolic link with the given "path" name.

"guestfs_stat" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.5.10 に お い て 追 加 )

guestfs_is_whole_device
int
guestfs_is_whole_device (guestfs_h *g,
const char *device);

This returns "true" if and only if "device" refers to a whole block device. That is, not a partition or a logical device.

This function returns a C truth value on success or -1 on error.

(1.21.9 に お い て 追 加 )

guestfs_is_zero
int
guestfs_is_zero (guestfs_h *g,
const char *path);

This returns true iff the file exists and the file is empty or it contains all zero bytes.

This function returns a C truth value on success or -1 on error.

(1.11.8 に お い て 追 加 )

guestfs_is_zero_device
int
guestfs_is_zero_device (guestfs_h *g,
const char *device);

This returns true iff the device exists and contains all zero bytes.

Note that for large devices this can take a long time to run.

This function returns a C truth value on success or -1 on error.

(1.11.8 に お い て 追 加 )

guestfs_isoinfo
struct guestfs_isoinfo *
guestfs_isoinfo (guestfs_h *g,
const char *isofile);

This is the same as "guestfs_isoinfo_device" except that it works for an ISO file located inside some other mounted filesystem. Note that in the common case where you have added an ISO file as a libguestfs device, you would not call this. Instead you would call "guestfs_isoinfo_device".

This function returns a "struct guestfs_isoinfo *", or NULL if there was an error. The caller must call "guestfs_free_isoinfo" after use.

(1.17.19 に お い て 追 加 )

guestfs_isoinfo_device
struct guestfs_isoinfo *
guestfs_isoinfo_device (guestfs_h *g,
const char *device);

"device" is an ISO device. This returns a struct of information read from the primary volume descriptor (the ISO equivalent of the superblock) of the device.

Usually it is more efficient to use the isoinfo(1) command with the -d option on the host to analyze ISO files, instead of going through libguestfs.

For information on the primary volume descriptor fields, see https://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor

This function returns a "struct guestfs_isoinfo *", or NULL if there was an error. The caller must call "guestfs_free_isoinfo" after use.

(1.17.19 に お い て 追 加 )

guestfs_journal_close
int
guestfs_journal_close (guestfs_h *g);

Close the journal handle. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_get
struct guestfs_xattr_list *
guestfs_journal_get (guestfs_h *g);

Read the current journal entry. This returns all the fields in the journal as a set of "(attrname, attrval)" pairs. The "attrname" is the field name (a string).

The "attrval" is the field value (a binary blob, often but not always a string). Please note that "attrval" is a byte array, not a \0-terminated C string.

The length of data may be truncated to the data threshold (see: "guestfs_journal_set_data_threshold", "guestfs_journal_get_data_threshold").

If you set the data threshold to unlimited (0) then this call can read a journal entry of any size, ie. it is not limited by the libguestfs protocol. こ の 関 数 は "struct guestfs_xattr_list *" を 返 し ま す 。 も し く は 、 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_xattr_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_get_data_threshold
int64_t
guestfs_journal_get_data_threshold (guestfs_h *g);

Get the current data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when reading them (note also that it may not truncate them). If this returns 0, then the threshold is unlimited.

See also "guestfs_journal_set_data_threshold". こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_get_realtime_usec
int64_t
guestfs_journal_get_realtime_usec (guestfs_h *g);

Get the realtime (wallclock) timestamp of the current journal entry. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.27.18)

guestfs_journal_next
int
guestfs_journal_next (guestfs_h *g);

Move to the next journal entry. You have to call this at least once after opening the handle before you are able to read data.

The returned boolean tells you if there are any more journal records to read. "true" means you can read the next record (eg. using "guestfs_journal_get"), and "false" means you have reached the end of the journal.

This function returns a C truth value on success or -1 on error.

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_open
int
guestfs_journal_open (guestfs_h *g,
const char *directory);

Open the systemd journal located in directory. Any previously opened journal handle is closed.

The contents of the journal can be read using "guestfs_journal_next" and "guestfs_journal_get".

After you have finished using the journal, you should close the handle by calling "guestfs_journal_close". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_set_data_threshold
int
guestfs_journal_set_data_threshold (guestfs_h *g,
int64_t threshold);

Set the data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when reading them (note also that it may not truncate them). If you set this to 0, then the threshold is unlimited.

See also "guestfs_journal_get_data_threshold". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_journal_skip
int64_t
guestfs_journal_skip (guestfs_h *g,
int64_t skip);

Skip forwards ("skip ≥ 0") or backwards ("skip < 0") in the journal.

The number of entries actually skipped is returned (note "rskip ≥ 0"). If this is not the same as the absolute value of the skip parameter ("|skip|") you passed in then it means you have reached the end or the start of the journal. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "journal". See also "guestfs_feature_available".

(Added in 1.23.11)

guestfs_kill_subprocess
int
guestfs_kill_subprocess (guestfs_h *g); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_shutdown" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This kills the hypervisor. こ れ を 呼 び 出 し て は い け ま せ ん 。 代 わ り に "guestfs_shutdown" を 参 照 し て く だ さ い 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(0.3 に お い て 追 加 )

guestfs_launch
int
guestfs_launch (guestfs_h *g);

You should call this after configuring the handle (eg. adding drives) but before performing any actions.

Do not call "guestfs_launch" twice on the same handle. Although it will not give an error (for historical reasons), the precise behaviour when you do this is not well defined. Handles are very cheap to create, so create a new one for each launch. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This long-running command can generate progress notification messages so that the caller can display a progress bar or indicator. To receive these messages, the caller must register a progress event callback. See "GUESTFS_EVENT_PROGRESS".

(0.3 に お い て 追 加 )

guestfs_lchown
int
guestfs_lchown (guestfs_h *g,
int owner,
int group,
const char *path);

Change the file owner to "owner" and group to "group". This is like "guestfs_chown" but if "path" is a symlink then the link itself is changed, not the target.

Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.77 に お い て 追 加 )

guestfs_ldmtool_create_all
int
guestfs_ldmtool_create_all (guestfs_h *g);

This function scans all block devices looking for Windows dynamic disk volumes and partitions, and creates devices for any that were found.

Call "guestfs_list_ldm_volumes" and "guestfs_list_ldm_partitions" to return all devices.

Note that you don’t normally need to call this explicitly, since it is done automatically at "guestfs_launch" time. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_diskgroup_disks
char **
guestfs_ldmtool_diskgroup_disks (guestfs_h *g,
const char *diskgroup);

Return the disks in a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "guestfs_ldmtool_scan".

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_diskgroup_name
char *
guestfs_ldmtool_diskgroup_name (guestfs_h *g,
const char *diskgroup);

Return the name of a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "guestfs_ldmtool_scan". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_diskgroup_volumes
char **
guestfs_ldmtool_diskgroup_volumes (guestfs_h *g,
const char *diskgroup);

Return the volumes in a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "guestfs_ldmtool_scan".

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_remove_all
int
guestfs_ldmtool_remove_all (guestfs_h *g);

This is essentially the opposite of "guestfs_ldmtool_create_all". It removes the device mapper mappings for all Windows dynamic disk volumes こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_scan
char **
guestfs_ldmtool_scan (guestfs_h *g);

This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These identifiers can be passed to other "guestfs_ldmtool_*" functions.

This function scans all block devices. To scan a subset of block devices, call "guestfs_ldmtool_scan_devices" instead.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_scan_devices
char **
guestfs_ldmtool_scan_devices (guestfs_h *g,
char *const *devices);

This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These identifiers can be passed to other "guestfs_ldmtool_*" functions.

The parameter "devices" is a list of block devices which are scanned. If this list is empty, all block devices are scanned.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_volume_hint
char *
guestfs_ldmtool_volume_hint (guestfs_h *g,
const char *diskgroup,
const char *volume);

Return the hint field of the volume named "volume" in the disk group with GUID "diskgroup". This may not be defined, in which case the empty string is returned. The hint field is often, though not always, the name of a Windows drive, eg. "E:". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_volume_partitions
char **
guestfs_ldmtool_volume_partitions (guestfs_h *g,
const char *diskgroup,
const char *volume);

Return the list of partitions in the volume named "volume" in the disk group with GUID "diskgroup".

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_ldmtool_volume_type
char *
guestfs_ldmtool_volume_type (guestfs_h *g,
const char *diskgroup,
const char *volume);

Return the type of the volume named "volume" in the disk group with GUID "diskgroup".

Possible volume types that can be returned here include: "simple", "spanned", "striped", "mirrored", "raid5". Other types may also be returned. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_lgetxattr
char *
guestfs_lgetxattr (guestfs_h *g,
const char *path,
const char *name,
size_t *size_r);

Get a single extended attribute from file "path" named "name". If "path" is a symlink, then this call returns an extended attribute from the symlink.

Normally it is better to get all extended attributes from a file in one go by calling "guestfs_getxattrs". However some Linux filesystem implementations are buggy and do not provide a way to list out attributes. For these filesystems (notably ntfs-3g) you have to know the names of the extended attributes you want in advance and call this function.

Extended attribute values are blobs of binary data. If there is no extended attribute named "name", this returns an error. 関 連 項 目 : "guestfs_lgetxattrs", "guestfs_getxattr", attr(5)

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.7.24 に お い て 追 加 )

guestfs_lgetxattrs
struct guestfs_xattr_list *
guestfs_lgetxattrs (guestfs_h *g,
const char *path);

This is the same as "guestfs_getxattrs", but if "path" is a symbolic link, then it returns the extended attributes of the link itself. こ の 関 数 は "struct guestfs_xattr_list *" を 返 し ま す 。 も し く は 、 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_xattr_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.59 に お い て 追 加 )

guestfs_list_9p
char **
guestfs_list_9p (guestfs_h *g);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This call does nothing and returns an error.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.11.12 に お い て 追 加 )

guestfs_list_devices
char **
guestfs_list_devices (guestfs_h *g); す べ て の ブ ロ ッ ク デ バ イ ス を 一 覧 表 示 し ま す 。

The full block device names are returned, eg. /dev/sda.

"guestfs_list_filesystems" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(0.4 に お い て 追 加 )

guestfs_list_disk_labels
char **
guestfs_list_disk_labels (guestfs_h *g);

If you add drives using the optional "label" parameter of "guestfs_add_drive_opts", you can use this call to map between disk labels, and raw block device and partition names (like /dev/sda and /dev/sda1).

This returns a hashtable, where keys are the disk labels (without the /dev/disk/guestfs prefix), and the values are the full raw block device and partition names (eg. /dev/sda and /dev/sda1).

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

(1.19.49 に お い て 追 加 )

guestfs_list_dm_devices
char **
guestfs_list_dm_devices (guestfs_h *g); す べ て の デ バ イ ス マ ッ パ ー デ バ イ ス を 一 覧 表 示 し ま す 。

The returned list contains /dev/mapper/* devices, eg. ones created by a previous call to "guestfs_luks_open".

Device mapper devices which correspond to logical volumes are not returned in this list. Call "guestfs_lvs" if you want to list logical volumes.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.11.15 に お い て 追 加 )

guestfs_list_filesystems
char **
guestfs_list_filesystems (guestfs_h *g);

This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of "mountables" containing filesystems and their type.

The return value is a hash, where the keys are the devices containing filesystems, and the values are the filesystem types. For example:

"/dev/sda1" => "ntfs"
"/dev/sda2" => "ext2"
"/dev/vg_guest/lv_root" => "ext4"
"/dev/vg_guest/lv_swap" => "swap"

The key is not necessarily a block device. It may also be an opaque ’mountable’ string which can be passed to "guestfs_mount".

The value can have the special value "unknown", meaning the content of the device is undetermined or empty. "swap" means a Linux swap partition.

In libguestfs ≤ 1.36 this command ran other libguestfs commands, which might have included "guestfs_mount" and "guestfs_umount", and therefore you had to use this soon after launch and only when nothing else was mounted. This restriction is removed in libguestfs ≥ 1.38.

Not all of the filesystems returned will be mountable. In particular, swap partitions are returned in the list. Also this command does not check that each filesystem found is valid and mountable, and some filesystems might be mountable but require special options. Filesystems may not all belong to a single logical operating system (use "guestfs_inspect_os" to look for OSes).

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

(1.5.15 に お い て 追 加 )

guestfs_list_ldm_partitions
char **
guestfs_list_ldm_partitions (guestfs_h *g);

This function returns all Windows dynamic disk partitions that were found at launch time. It returns a list of device names.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_list_ldm_volumes
char **
guestfs_list_ldm_volumes (guestfs_h *g);

This function returns all Windows dynamic disk volumes that were found at launch time. It returns a list of device names.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "ldm". See also "guestfs_feature_available".

(1.20.0 に お い て 追 加 )

guestfs_list_md_devices
char **
guestfs_list_md_devices (guestfs_h *g); す べ て の Linux md デ バ イ ス を 一 覧 表 示 し ま す 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.15.4 に お い て 追 加 )

guestfs_list_partitions
char **
guestfs_list_partitions (guestfs_h *g);

List all the partitions detected on all block devices.

The full partition device names are returned, eg. /dev/sda1

This does not return logical volumes. For that you will need to call "guestfs_lvs".

"guestfs_list_filesystems" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(0.4 に お い て 追 加 )

guestfs_ll
char *
guestfs_ll (guestfs_h *g,
const char *directory);

List the files in directory (relative to the root directory, there is no cwd) in the format of "ls -la". こ の コ マ ン ド は ほ と ん ど の 対 話 式 セ ッ シ ョ ン の た め に 有 用 で す 。 出 力 文 字 列 を 構 文 解 析 し よ う と い う 意 図 は あ り ま せ ん 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(0.4 に お い て 追 加 )

guestfs_llz
char *
guestfs_llz (guestfs_h *g,
const char *directory);

This function is deprecated. In new code, use the "guestfs_lgetxattrs" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

List the files in directory in the format of "ls -laZ". こ の コ マ ン ド は ほ と ん ど の 対 話 式 セ ッ シ ョ ン の た め に 有 用 で す 。 出 力 文 字 列 を 構 文 解 析 し よ う と い う 意 図 は あ り ま せ ん 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.17.6 に お い て 追 加 )

guestfs_ln
int
guestfs_ln (guestfs_h *g,
const char *target,
const char *linkname);

This command creates a hard link. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.66 に お い て 追 加 )

guestfs_ln_f
int
guestfs_ln_f (guestfs_h *g,
const char *target,
const char *linkname);

This command creates a hard link, removing the link "linkname" if it exists already. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.66 に お い て 追 加 )

guestfs_ln_s
int
guestfs_ln_s (guestfs_h *g,
const char *target,
const char *linkname); こ の コ マ ン ド は "ln -s" コ マ ン ド を 使 用 し て シ ン ボ リ ッ ク リ ン ク を 作 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.66 に お い て 追 加 )

guestfs_ln_sf
int
guestfs_ln_sf (guestfs_h *g,
const char *target,
const char *linkname);

This command creates a symbolic link using the "ln -sf" command, The -f option removes the link ("linkname") if it exists already. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.66 に お い て 追 加 )

guestfs_lremovexattr
int
guestfs_lremovexattr (guestfs_h *g,
const char *xattr,
const char *path); こ れ は "guestfs_removexattr" と 同 じ で す 。 た だ し 、 "path" が シ ン ボ リ ッ ク リ ン ク な ら ば 、 リ ン ク 自 身 の 拡 張 属 性 を 削 除 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.59 に お い て 追 加 )

guestfs_ls
char **
guestfs_ls (guestfs_h *g,
const char *directory);

List the files in directory (relative to the root directory, there is no cwd). The "." and ".." entries are not returned, but hidden files are shown.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(0.4 に お い て 追 加 )

guestfs_ls0
int
guestfs_ls0 (guestfs_h *g,
const char *dir,
const char *filenames);

This specialized command is used to get a listing of the filenames in the directory "dir". The list of filenames is written to the local file filenames (on the host). 出 力 フ ァ イ ル に お い て 、 フ ァ イ ル 名 が "\0" 文 字 に よ り 区 切 ら れ ま す 。

"." お よ び ".." は 返 さ れ ま せ ん 。 フ ァ イ ル 名 は 並 べ 替 え ら れ ま せ ん 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.32 に お い て 追 加 )

guestfs_lsetxattr
int
guestfs_lsetxattr (guestfs_h *g,
const char *xattr,
const char *val,
int vallen,
const char *path); こ れ は "guestfs_setxattr" と 同 じ で す が 、 "path" が シ ン ボ リ ッ ク リ ン ク で す 。 そ し て 、 リ ン ク 自 身 の 拡 張 属 性 を 設 定 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.59 に お い て 追 加 )

guestfs_lstat
struct guestfs_stat *
guestfs_lstat (guestfs_h *g,
const char *path);

This function is deprecated. In new code, use the "guestfs_lstatns" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. 与 え ら れ た "path" の フ ァ イ ル 情 報 を 返 し ま す 。 こ れ は 、 "path" が シ ン ボ リ ッ ク リ ン ク で あ る こ と を 除 き 、 "guestfs_stat" と 同 じ で す 。 そ し て リ ン ク は 、 参 照 し て い る フ ァ イ ル で は な く 、 stat-ed で す 。

This is the same as the lstat(2) system call. こ の 関 数 は "struct guestfs_stat *" を 返 し ま す 。 エ ラ ー が あ れ ば NULL で す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_stat" を 呼 び 出 す 必 要 が あ り ま す 。

(Added in 1.9.2)

guestfs_lstatlist
struct guestfs_stat_list *
guestfs_lstatlist (guestfs_h *g,
const char *path,
char *const *names);

This function is deprecated. In new code, use the "guestfs_lstatnslist" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This call allows you to perform the "guestfs_lstat" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a list of stat structs, with a one-to-one correspondence to the "names" list. If any name did not exist or could not be lstat’d, then the "st_ino" field of that structure is set to -1.

This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "guestfs_lxattrlist" for a similarly efficient call for getting extended attributes.

This function returns a "struct guestfs_stat_list *", or NULL if there was an error. The caller must call "guestfs_free_stat_list" after use.

(1.0.77 に お い て 追 加 )

guestfs_lstatns
struct guestfs_statns *
guestfs_lstatns (guestfs_h *g,
const char *path); 与 え ら れ た "path" の フ ァ イ ル 情 報 を 返 し ま す 。

This is the same as "guestfs_statns" except that if "path" is a symbolic link, then the link is stat-ed, not the file it refers to.

This is the same as the lstat(2) system call.

This function returns a "struct guestfs_statns *", or NULL if there was an error. The caller must call "guestfs_free_statns" after use.

(Added in 1.27.53)

guestfs_lstatnslist
struct guestfs_statns_list *
guestfs_lstatnslist (guestfs_h *g,
const char *path,
char *const *names);

This call allows you to perform the "guestfs_lstatns" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a list of stat structs, with a one-to-one correspondence to the "names" list. If any name did not exist or could not be lstat’d, then the "st_ino" field of that structure is set to -1.

This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "guestfs_lxattrlist" for a similarly efficient call for getting extended attributes.

This function returns a "struct guestfs_statns_list *", or NULL if there was an error. The caller must call "guestfs_free_statns_list" after use.

(Added in 1.27.53)

guestfs_luks_add_key
int
guestfs_luks_add_key (guestfs_h *g,
const char *device,
const char *key,
const char *newkey,
int keyslot);

This command adds a new key on LUKS device "device". "key" is any existing key, and is used to access the device. "newkey" is the new key to add. "keyslot" is the key slot that will be replaced.

Note that if "keyslot" already contains a key, then this command will fail. You have to use "guestfs_luks_kill_slot" first to remove that key. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.2 に お い て 追 加 )

guestfs_luks_close
int
guestfs_luks_close (guestfs_h *g,
const char *device);

This function is deprecated. In new code, use the "guestfs_cryptsetup_close" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This closes a LUKS device that was created earlier by "guestfs_luks_open" or "guestfs_luks_open_ro". The "device" parameter must be the name of the LUKS mapping device (ie. /dev/mapper/mapname) and not the name of the underlying block device. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.1 に お い て 追 加 )

guestfs_luks_format
int
guestfs_luks_format (guestfs_h *g,
const char *device,
const char *key,
int keyslot);

This command erases existing data on "device" and formats the device as a LUKS encrypted device. "key" is the initial key, which is added to key slot "keyslot". (LUKS supports 8 key slots, numbered 0-7). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.2 に お い て 追 加 )

guestfs_luks_format_cipher
int
guestfs_luks_format_cipher (guestfs_h *g,
const char *device,
const char *key,
int keyslot,
const char *cipher);

This command is the same as "guestfs_luks_format" but it also allows you to set the "cipher" used. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.2 に お い て 追 加 )

guestfs_luks_kill_slot
int
guestfs_luks_kill_slot (guestfs_h *g,
const char *device,
const char *key,
int keyslot);

This command deletes the key in key slot "keyslot" from the encrypted LUKS device "device". "key" must be one of the other keys. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.2 に お い て 追 加 )

guestfs_luks_open
int
guestfs_luks_open (guestfs_h *g,
const char *device,
const char *key,
const char *mapname);

This function is deprecated. In new code, use the "guestfs_cryptsetup_open" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard.

"device" is the encrypted block device or partition.

The caller must supply one of the keys associated with the LUKS block device, in the "key" parameter.

This creates a new block device called /dev/mapper/mapname. Reads and writes to this block device are decrypted from and encrypted to the underlying "device" respectively.

If this block device contains LVM volume groups, then calling "guestfs_lvm_scan" with the "activate" parameter "true" will make them visible. す べ て の デ バ イ ス マ ッ パ ー デ バ イ ス を 一 覧 表 示 す る に は "guestfs_list_dm_devices" を 使 用 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.1 に お い て 追 加 )

guestfs_luks_open_ro
int
guestfs_luks_open_ro (guestfs_h *g,
const char *device,
const char *key,
const char *mapname);

This function is deprecated. In new code, use the "guestfs_cryptsetup_open" call instead.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は 、 読 み 込 み 専 用 の マ ッ ピ ン グ が 作 成 さ れ る こ と を 除 き 、 "guestfs_luks_open" と 同 じ で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function takes a key or passphrase parameter which could contain sensitive material. Read the section "KEYS AND PASSPHRASES" for more information.

This function depends on the feature "luks". See also "guestfs_feature_available".

(1.5.1 に お い て 追 加 )

guestfs_luks_uuid
char *
guestfs_luks_uuid (guestfs_h *g,
const char *device);

This returns the UUID of the LUKS device "device". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "luks". See also "guestfs_feature_available".

(Added in 1.41.9)

guestfs_lvcreate
int
guestfs_lvcreate (guestfs_h *g,
const char *logvol,
const char *volgroup,
int mbytes);

This creates an LVM logical volume called "logvol" on the volume group "volgroup", with "size" megabytes. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.8 に お い て 追 加 )

guestfs_lvcreate_free
int
guestfs_lvcreate_free (guestfs_h *g,
const char *logvol,
const char *volgroup,
int percent);

Create an LVM logical volume called /dev/volgroup/logvol, using approximately "percent" % of the free space remaining in the volume group. Most usefully, when "percent" is 100 this will create the largest possible LV. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.17.18 に お い て 追 加 )

guestfs_lvm_canonical_lv_name
char *
guestfs_lvm_canonical_lv_name (guestfs_h *g,
const char *lvname);

This converts alternative naming schemes for LVs that you might find to the canonical name. For example, /dev/mapper/VG-LV is converted to /dev/VG/LV.

This command returns an error if the "lvname" parameter does not refer to a logical volume. In this case errno will be set to "EINVAL".

"guestfs_is_lv", "guestfs_canonical_device_name" も 参 照 し て く だ さ い 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.24 に お い て 追 加 )

guestfs_lvm_clear_filter
int
guestfs_lvm_clear_filter (guestfs_h *g);

This undoes the effect of "guestfs_lvm_set_filter". LVM will be able to see every block device.

This command also clears the LVM cache and performs a volume group scan. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.5.1 に お い て 追 加 )

guestfs_lvm_remove_all
int
guestfs_lvm_remove_all (guestfs_h *g);

This command removes all LVM logical volumes, volume groups and physical volumes. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.8 に お い て 追 加 )

guestfs_lvm_scan
int
guestfs_lvm_scan (guestfs_h *g,
int activate);

This scans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes.

If the "activate" parameter is "true" then newly found volume groups and logical volumes are activated, meaning the LV /dev/VG/LV devices become visible.

When a libguestfs handle is launched it scans for existing devices, so you do not normally need to use this API. However it is useful when you have added a new device or deleted an existing device (such as when the "guestfs_luks_open" API is used). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(Added in 1.39.8)

guestfs_lvm_set_filter
int
guestfs_lvm_set_filter (guestfs_h *g,
char *const *devices);

This sets the LVM device filter so that LVM will only be able to "see" the block devices in the list "devices", and will ignore all other attached block devices.

Where disk image(s) contain duplicate PVs or VGs, this command is useful to get LVM to ignore the duplicates, otherwise LVM can get confused. Note also there are two types of duplication possible: either cloned PVs/VGs which have identical UUIDs; or VGs that are not cloned but just happen to have the same name. In normal operation you cannot create this situation, but you can do it outside LVM, eg. by cloning disk images or by bit twiddling inside the LVM metadata.

This command also clears the LVM cache and performs a volume group scan.

You can filter whole block devices or individual partitions.

You cannot use this if any VG is currently in use (eg. contains a mounted filesystem), even if you are not filtering out that VG. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.5.1 に お い て 追 加 )

guestfs_lvremove
int
guestfs_lvremove (guestfs_h *g,
const char *device);

Remove an LVM logical volume "device", where "device" is the path to the LV, such as /dev/VG/LV.

You can also remove all LVs in a volume group by specifying the VG name, /dev/VG. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.0.13 に お い て 追 加 )

guestfs_lvrename
int
guestfs_lvrename (guestfs_h *g,
const char *logvol,
const char *newlogvol);

Rename a logical volume "logvol" with the new name "newlogvol". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.83 に お い て 追 加 )

guestfs_lvresize
int
guestfs_lvresize (guestfs_h *g,
const char *device,
int mbytes); こ れ は 既 存 の LVM 論 理 ボ リ ュ ー ム を "mbytes" に 容 量 変 更 （ 拡 大 ま た は 縮 小 ） し ま す 。 縮 小 す る と き 、 縮 小 さ れ た 部 分 に あ る デ ー タ は 失 わ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.0.27 に お い て 追 加 )

guestfs_lvresize_free
int
guestfs_lvresize_free (guestfs_h *g,
const char *lv,
int percent);

This expands an existing logical volume "lv" so that it fills "pc" % of the remaining free space in the volume group. Commonly you would call this with pc = 100 which expands the logical volume as much as possible, using all remaining free space in the volume group. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.3.3 に お い て 追 加 )

guestfs_lvs
char **
guestfs_lvs (guestfs_h *g);

List all the logical volumes detected. This is the equivalent of the lvs(8) command.

This returns a list of the logical volume device names (eg. /dev/VolGroup00/LogVol00).

"guestfs_lvs_full", "guestfs_list_filesystems" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.4 に お い て 追 加 )

guestfs_lvs_full
struct guestfs_lvm_lv_list *
guestfs_lvs_full (guestfs_h *g);

List all the logical volumes detected. This is the equivalent of the lvs(8) command. The "full" version includes all fields.

This function returns a "struct guestfs_lvm_lv_list *", or NULL if there was an error. The caller must call "guestfs_free_lvm_lv_list" after use.

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.4 に お い て 追 加 )

guestfs_lvuuid
char *
guestfs_lvuuid (guestfs_h *g,
const char *device); こ の コ マ ン ド は LVM 論 理 ボ リ ュ ー ム "device" の UUID を 返 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.87 に お い て 追 加 )

guestfs_lxattrlist
struct guestfs_xattr_list *
guestfs_lxattrlist (guestfs_h *g,
const char *path,
char *const *names);

This call allows you to get the extended attributes of multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a flat list of xattr structs which must be interpreted sequentially. The first xattr struct always has a zero-length "attrname". "attrval" in this struct is zero-length to indicate there was an error doing "guestfs_lgetxattr" for this file, or is a C string which is a decimal number (the number of following attributes for this file, which could be "0"). Then after the first xattr struct are the zero or more attributes for the first named file. This repeats for the second and subsequent files.

This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "guestfs_lstatlist" for a similarly efficient call for getting standard stats. こ の 関 数 は "struct guestfs_xattr_list *" を 返 し ま す 。 も し く は 、 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_xattr_list" を 呼 び 出 す 必 要 が あ り ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.77 に お い て 追 加 )

guestfs_max_disks
int
guestfs_max_disks (guestfs_h *g); ハ ン ド ル に 追 加 で き る デ ィ ス ク の 最 大 数 を 返 し ま す (例 : "guestfs_add_drive_opts" お よ び 同 様 の 呼 び 出 し )。

This function was added in libguestfs 1.19.7. In previous versions of libguestfs the limit was 25. こ の 話 題 に 関 す る 詳 細 は "MAXIMUM NUMBER OF DISKS" を 参 照 し て く だ さ い 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.19.7 に お い て 追 加 )

guestfs_md_create
int
guestfs_md_create (guestfs_h *g,
const char *name,
char *const *devices,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MD_CREATE_MISSINGBITMAP, int64_t missingbitmap,
GUESTFS_MD_CREATE_NRDEVICES, int nrdevices,
GUESTFS_MD_CREATE_SPARE, int spare,
GUESTFS_MD_CREATE_CHUNK, int64_t chunk,
GUESTFS_MD_CREATE_LEVEL, const char *level,

Create a Linux md (RAID) device named "name" on the devices in the list "devices". オ プ シ ョ ン の パ ラ メ ー タ ー は 次 の と お り で す :
"missingbitmap"

A bitmap of missing devices. If a bit is set it means that a missing device is added to the array. The least significant bit corresponds to the first device in the array. 例 と し て :

"devices = ["/dev/sda"]" か つ "missingbitmap = 0x1" な ら ば 、 結 果 の 配 列 は "[<missing>, "/dev/sda"]" に な り ま す 。

"devices = ["/dev/sda"]" か つ "missingbitmap = 0x2" な ら ば 、 結 果 の 配 列 は "["/dev/sda", <missing>]" に な り ま す 。 こ の 初 期 値 は 0 で す （ デ バ イ ス が あ り ま せ ん ） 。

"devices" の 長 さ + "missingbitmap" に 設 定 さ れ た ビ ッ ト 数 は "nrdevices" + "spare" と 同 じ で あ る 必 要 が あ り ま す 。

"nrdevices" 稼 動 中 の RAID デ バ イ ス 数 。 設 定 さ れ て い な い と 、 こ の 初 期 値 は "devices" の 長 さ + "missingbitmap" に 設 定 さ れ た ビ ッ ト 数 に な り ま す 。
"spare" 予 備 デ バ イ ス 数 。 設 定 さ れ て い な け れ ば 、 デ フ ォ ル ト は 0 で す 。
"chunk" バ イ ト 単 位 の チ ャ ン ク 容 量 で す 。

The "chunk" parameter does not make sense, and should not be specified, when "level" is "raid1" (which is the default; see below).

"level"

The RAID level, which can be one of: "linear", "raid0", 0, "stripe", "raid1", 1, "mirror", "raid4", 4, "raid5", 5, "raid6", 6, "raid10", 10. Some of these are synonymous, and more levels may be added in future. 設 定 さ れ て い な い と 、 こ の 初 期 値 は "raid1" で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mdadm". See also "guestfs_feature_available".

(1.15.6 に お い て 追 加 )

guestfs_md_create_va
int
guestfs_md_create_va (guestfs_h *g,
const char *name,
char *const *devices,
va_list args); こ れ は "guestfs_md_create" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_md_create_argv
int
guestfs_md_create_argv (guestfs_h *g,
const char *name,
char *const *devices,
const struct guestfs_md_create_argv *optargs); こ れ は "guestfs_md_create" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_md_detail
char **
guestfs_md_detail (guestfs_h *g,
const char *md);

This command exposes the output of "mdadm -DY <md>". The following fields are usually present in the returned hash. Other fields may also be present.
"level"

MD デ バ イ ス の RAID レ ベ ル 。

"devices"

MD デ バ イ ス に あ る デ バ イ ス 数 。

"metadata" 使 用 さ れ て い る メ タ 情 報 の バ ー ジ ョ ン 。
"uuid"

MD デ バ イ ス の UUID。

"name"

MD デ バ イ ス の 名 前 。

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

This function depends on the feature "mdadm". See also "guestfs_feature_available".

(1.15.6 に お い て 追 加 )

guestfs_md_stat
struct guestfs_mdstat_list *
guestfs_md_stat (guestfs_h *g,
const char *md);

This call returns a list of the underlying devices which make up the single software RAID array device "md". ソ フ ト ウ ェ ア RAID デ バ イ ス の 一 覧 を 取 得 す る に は 、 "guestfs_list_md_devices" を 呼 び 出 し ま す 。

Each structure returned corresponds to one device along with additional status information:
"mdstat_device" 下 に あ る デ バ イ ス の 名 前 で す 。
"mdstat_index" 配 列 の 中 に あ る こ の デ バ イ ス の イ ン デ ッ ク ス で す 。
"mdstat_flags"

Flags associated with this device. This is a string containing (in no specific order) zero or more of the following flags:

RAIDス ペ ア デ バ イ ス

This function returns a "struct guestfs_mdstat_list *", or NULL if there was an error. The caller must call "guestfs_free_mdstat_list" after use.

This function depends on the feature "mdadm". See also "guestfs_feature_available".

(1.17.21 に お い て 追 加 )

guestfs_md_stop
int
guestfs_md_stop (guestfs_h *g,
const char *md); こ の コ マ ン ド は "md" と い う 名 前 の MD ア レ イ を 無 効 化 し ま す 。 デ バ イ ス が 停 止 さ れ ま す が 、 破 壊 ま た は ゼ ロ 書 き 込 み さ れ ま せ ん 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mdadm". See also "guestfs_feature_available".

(1.15.6 に お い て 追 加 )

guestfs_mkdir
int
guestfs_mkdir (guestfs_h *g,
const char *path);

"path" と い う 名 前 の デ ィ レ ク ト リ ー を 作 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(0.8 に お い て 追 加 )

guestfs_mkdir_mode
int
guestfs_mkdir_mode (guestfs_h *g,
const char *path,
int mode); こ の コ マ ン ド は デ ィ レ ク ト リ ー を 作 成 し ま す 、 デ ィ レ ク ト リ ー の 初 期 パ ー ミ ッ シ ョ ン を "mode" に 設 定 し ま す 。 一 般 的 な Linux フ ァ イ ル シ ス テ ム に 対 し て 、 設 定 さ れ て い る 実 際 の モ ー ド が "mode & ~umask & 01777" と さ れ ま す 。 Linux 固 有 の フ ァ イ ル シ ス テ ム 以 外 は 他 の 方 法 で モ ー ド を 解 釈 し ま す 。

"guestfs_mkdir", "guestfs_umask" 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.77 に お い て 追 加 )

guestfs_mkdir_p
int
guestfs_mkdir_p (guestfs_h *g,
const char *path);

"path" と い う 名 前 の デ ィ レ ク ト リ ー を 作 成 し ま す 、 必 要 に 応 じ て 親 デ ィ レ ク ト リ ー を 作 成 し ま す 。 こ れ は "mkdir -p" シ ェ ル コ マ ン ド と 似 て い ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(0.8 に お い て 追 加 )

guestfs_mkdtemp
char *
guestfs_mkdtemp (guestfs_h *g,
const char *tmpl);

This command creates a temporary directory. The "tmpl" parameter should be a full pathname for the temporary directory name with the final six characters being "XXXXXX". 例 : "/tmp/myprogXXXXXX" ま た は "/Temp/myprogXXXXXX"、 2 つ め の 例 は Windows フ ァ イ ル シ ス テ ム に 適 し て い ま す 。 作 成 さ れ た 一 時 デ ィ レ ク ト リ ー の 名 前 を 返 し ま す 。 一 時 デ ィ レ ク ト リ ー が モ ー ド 0700 で 作 成 さ れ 、 root に よ り 所 有 さ れ ま す 。

The caller is responsible for deleting the temporary directory and its contents after use. 関 連 項 目 : mkdtemp(3) こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.54 に お い て 追 加 )

guestfs_mke2fs
int
guestfs_mke2fs (guestfs_h *g,
const char *device,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKE2FS_BLOCKSCOUNT, int64_t blockscount,
GUESTFS_MKE2FS_BLOCKSIZE, int64_t blocksize,
GUESTFS_MKE2FS_FRAGSIZE, int64_t fragsize,
GUESTFS_MKE2FS_BLOCKSPERGROUP, int64_t blockspergroup,
GUESTFS_MKE2FS_NUMBEROFGROUPS, int64_t numberofgroups,
GUESTFS_MKE2FS_BYTESPERINODE, int64_t bytesperinode,
GUESTFS_MKE2FS_INODESIZE, int64_t inodesize,
GUESTFS_MKE2FS_JOURNALSIZE, int64_t journalsize,
GUESTFS_MKE2FS_NUMBEROFINODES, int64_t numberofinodes,
GUESTFS_MKE2FS_STRIDESIZE, int64_t stridesize,
GUESTFS_MKE2FS_STRIPEWIDTH, int64_t stripewidth,
GUESTFS_MKE2FS_MAXONLINERESIZE, int64_t maxonlineresize,
GUESTFS_MKE2FS_RESERVEDBLOCKSPERCENTAGE, int reservedblockspercentage,
GUESTFS_MKE2FS_MMPUPDATEINTERVAL, int mmpupdateinterval,
GUESTFS_MKE2FS_JOURNALDEVICE, const char *journaldevice,
GUESTFS_MKE2FS_LABEL, const char *label,
GUESTFS_MKE2FS_LASTMOUNTEDDIR, const char *lastmounteddir,
GUESTFS_MKE2FS_CREATOROS, const char *creatoros,
GUESTFS_MKE2FS_FSTYPE, const char *fstype,
GUESTFS_MKE2FS_USAGETYPE, const char *usagetype,
GUESTFS_MKE2FS_UUID, const char *uuid,
GUESTFS_MKE2FS_FORCECREATE, int forcecreate,
GUESTFS_MKE2FS_WRITESBANDGROUPONLY, int writesbandgrouponly,
GUESTFS_MKE2FS_LAZYITABLEINIT, int lazyitableinit,
GUESTFS_MKE2FS_LAZYJOURNALINIT, int lazyjournalinit,
GUESTFS_MKE2FS_TESTFS, int testfs,
GUESTFS_MKE2FS_DISCARD, int discard,
GUESTFS_MKE2FS_QUOTATYPE, int quotatype,
GUESTFS_MKE2FS_EXTENT, int extent,
GUESTFS_MKE2FS_FILETYPE, int filetype,
GUESTFS_MKE2FS_FLEXBG, int flexbg,
GUESTFS_MKE2FS_HASJOURNAL, int hasjournal,
GUESTFS_MKE2FS_JOURNALDEV, int journaldev,
GUESTFS_MKE2FS_LARGEFILE, int largefile,
GUESTFS_MKE2FS_QUOTA, int quota,
GUESTFS_MKE2FS_RESIZEINODE, int resizeinode,
GUESTFS_MKE2FS_SPARSESUPER, int sparsesuper,
GUESTFS_MKE2FS_UNINITBG, int uninitbg,

"mke2fs" is used to create an ext2, ext3, or ext4 filesystem on "device".

The optional "blockscount" is the size of the filesystem in blocks. If omitted it defaults to the size of "device". Note if the filesystem is too small to contain a journal, "mke2fs" will silently create an ext2 filesystem instead. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.44 に お い て 追 加 )

guestfs_mke2fs_va
int
guestfs_mke2fs_va (guestfs_h *g,
const char *device,
va_list args); こ れ は "guestfs_mke2fs" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mke2fs_argv
int
guestfs_mke2fs_argv (guestfs_h *g,
const char *device,
const struct guestfs_mke2fs_argv *optargs);

This is the "argv variant" of "guestfs_mke2fs".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mke2fs_J
int
guestfs_mke2fs_J (guestfs_h *g,
const char *fstype,
int blocksize,
const char *device,
const char *journal); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は 外 部 ジ ャ ー ナ ル を "journal" に 持 つ ext2/3/4 フ ァ イ ル シ ス テ ム を "device" に 作 成 し ま す 。 次 の コ マ ン ド と 同 じ で す :

mke2fs -t fstype -b blocksize -J device=<journal> <device>

"guestfs_mke2journal" 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.68 に お い て 追 加 )

guestfs_mke2fs_JL
int
guestfs_mke2fs_JL (guestfs_h *g,
const char *fstype,
int blocksize,
const char *device,
const char *label); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は 外 部 ジ ャ ー ナ ル を ジ ャ ー ナ ル ラ ベ ル "label" に 持 つ ext2/3/4 フ ァ イ ル シ ス テ ム を "device" に 作 成 し ま す 。

"guestfs_mke2journal_L" 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.68 に お い て 追 加 )

guestfs_mke2fs_JU
int
guestfs_mke2fs_JU (guestfs_h *g,
const char *fstype,
int blocksize,
const char *device,
const char *uuid); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は 外 部 ジ ャ ー ナ ル を UUID "uuid" の ジ ャ ー ナ ル に 持 つ ext2/3/4 フ ァ イ ル シ ス テ ム を "device" に 作 成 し ま す 。

"guestfs_mke2journal_U" 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxfsuuid". See also "guestfs_feature_available".

(1.0.68 に お い て 追 加 )

guestfs_mke2journal
int
guestfs_mke2journal (guestfs_h *g,
int blocksize,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は "device" に ext2 外 部 ジ ャ ー ナ ル を 作 成 し ま す 。 次 の コ マ ン ド と 同 じ で す :

mke2fs -O journal_dev -b blocksize device こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.68 に お い て 追 加 )

guestfs_mke2journal_L
int
guestfs_mke2journal_L (guestfs_h *g,
int blocksize,
const char *label,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. こ れ は ラ ベ ル "label" を 持 つ "device" に ext2 外 部 ジ ャ ー ナ ル を 作 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.68 に お い て 追 加 )

guestfs_mke2journal_U
int
guestfs_mke2journal_U (guestfs_h *g,
int blocksize,
const char *uuid,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mke2fs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This creates an ext2 external journal on "device" with UUID "uuid". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxfsuuid". See also "guestfs_feature_available".

(1.0.68 に お い て 追 加 )

guestfs_mkfifo
int
guestfs_mkfifo (guestfs_h *g,
int mode,
const char *path);

This call creates a FIFO (named pipe) called "path" with mode "mode". It is just a convenient wrapper around "guestfs_mknod".

Unlike with "guestfs_mknod", "mode" must contain only permissions bits. 実 際 に 設 定 さ れ る モ ー ド は umask に よ り 影 響 さ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mknod". See also "guestfs_feature_available".

(1.0.55 に お い て 追 加 )

guestfs_mkfs
int
guestfs_mkfs (guestfs_h *g,
const char *fstype,
const char *device);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_mkfs_opts" with no optional arguments.

(0.8 に お い て 追 加 )

guestfs_mkfs_opts
int
guestfs_mkfs_opts (guestfs_h *g,
const char *fstype,
const char *device,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,
GUESTFS_MKFS_OPTS_FEATURES, const char *features,
GUESTFS_MKFS_OPTS_INODE, int inode,
GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,
GUESTFS_MKFS_OPTS_LABEL, const char *label,

This function creates a filesystem on "device". The filesystem type is "fstype", for example "ext3". オ プ シ ョ ン 引 数 は 次 の と お り で す :
"blocksize" フ ァ イ ル シ ス テ ム の ブ ロ ッ ク 容 量 で す 。 サ ポ ー ト さ れ る ブ ロ ッ ク 容 量 は 、 フ ァ イ ル シ ス テ ム の 形 式 に 依 存 し ま す 。 一 般 的 に Linux ext2/3 フ ァ イ ル シ ス テ ム に は 1024, 2048 ま た は 4096 で す 。

For VFAT and NTFS the "blocksize" parameter is treated as the requested cluster size.

UFS ブ ロ ッ ク 容 量 は mkfs.ufs(8) を 参 照 し て く だ さ い 。

"特 徴 " こ れ は -O パ ラ メ ー タ ー を 外 部 の mkfs プ ロ グ ラ ム に 渡 し ま す 。 特 定 の フ ァ イ ル シ ス テ ム 形 式 に は 、 追 加 の フ ァ イ ル シ ス テ ム 機 能 が 選 択 で き ま す 。 詳 細 は mke2fs(8) お よ び mkfs.ufs(8) を 参 照 し て く だ さ い 。

"gfs" ま た は "gfs2" フ ァ イ ル シ ス テ ム 形 式 で は こ の オ プ シ ョ ン の パ ラ メ ー タ ー を 使 用 で き ま せ ん 。

"inode"

This passes the -I parameter to the external mke2fs(8) program which sets the inode size (only for ext2/3/4 filesystems at present).

"sectorsize"

This passes the -S parameter to external mkfs.ufs(8) program, which sets sector size for ufs filesystem. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(0.8 に お い て 追 加 )

guestfs_mkfs_opts_va
int
guestfs_mkfs_opts_va (guestfs_h *g,
const char *fstype,
const char *device,
va_list args); こ れ は "guestfs_mkfs_opts" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkfs_opts_argv
int
guestfs_mkfs_opts_argv (guestfs_h *g,
const char *fstype,
const char *device,
const struct guestfs_mkfs_opts_argv *optargs); こ れ は "guestfs_mkfs_opts" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkfs_b
int
guestfs_mkfs_b (guestfs_h *g,
const char *fstype,
int blocksize,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mkfs" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This call is similar to "guestfs_mkfs", but it allows you to control the block size of the resulting filesystem. Supported block sizes depend on the filesystem type, but typically they are 1024, 2048 or 4096 only.

For VFAT and NTFS the "blocksize" parameter is treated as the requested cluster size. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.68 に お い て 追 加 )

guestfs_mkfs_btrfs
int
guestfs_mkfs_btrfs (guestfs_h *g,
char *const *devices,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKFS_BTRFS_ALLOCSTART, int64_t allocstart,
GUESTFS_MKFS_BTRFS_BYTECOUNT, int64_t bytecount,
GUESTFS_MKFS_BTRFS_DATATYPE, const char *datatype,
GUESTFS_MKFS_BTRFS_LEAFSIZE, int leafsize,
GUESTFS_MKFS_BTRFS_LABEL, const char *label,
GUESTFS_MKFS_BTRFS_METADATA, const char *metadata,
GUESTFS_MKFS_BTRFS_NODESIZE, int nodesize,
GUESTFS_MKFS_BTRFS_SECTORSIZE, int sectorsize, す べ て の 設 定 可 能 な も の に つ い て 設 定 を 許 可 し て 、 btrfs フ ァ イ ル シ ス テ ム を 作 成 し ま す 。 オ プ シ ョ ン 引 数 の 詳 細 は mkfs.btrfs(8) を 参 照 し て く だ さ い 。

btrfs フ ァ イ ル シ ス テ ム は 複 数 の デ バ イ ス を 結 合 で き る の で 、 こ れ は 非 空 白 の デ バ イ ス 一 覧 を と り ま す 。 一 般 的 な フ ァ イ ル シ ス テ ム を 作 成 す る に は "guestfs_mkfs" を 使 用 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "btrfs". See also "guestfs_feature_available".

(1.17.25 に お い て 追 加 )

guestfs_mkfs_btrfs_va
int
guestfs_mkfs_btrfs_va (guestfs_h *g,
char *const *devices,
va_list args); こ れ は "guestfs_mkfs_btrfs" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkfs_btrfs_argv
int
guestfs_mkfs_btrfs_argv (guestfs_h *g,
char *const *devices,
const struct guestfs_mkfs_btrfs_argv *optargs); こ れ は "guestfs_mkfs_btrfs" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mklost_and_found
int
guestfs_mklost_and_found (guestfs_h *g,
const char *mountpoint);

Make the "lost+found" directory, normally in the root directory of an ext2/3/4 filesystem. "mountpoint" is the directory under which we try to create the "lost+found" directory. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.56 に お い て 追 加 )

guestfs_mkmountpoint
int
guestfs_mkmountpoint (guestfs_h *g,
const char *exemptpath);

"guestfs_mkmountpoint" お よ び "guestfs_rmmountpoint" は 、 最 初 の フ ァ イ ル シ ス テ ム を マ ウ ン ト す る 前 に 追 加 の マ ウ ン ト ポ イ ン ト を 作 成 す る た め に 使 用 で き る 、 特 別 な 呼 び 出 し で す 。

These calls are only necessary in some very limited circumstances, mainly the case where you want to mount a mix of unrelated and/or read-only filesystems together.

For example, live CDs often contain a "Russian doll" nest of filesystems, an ISO outer layer, with a squashfs image inside, with an ext2/3 image inside that. You can unpack this as follows in guestfish:

add-ro Fedora-11-i686-Live.iso
run
mkmountpoint /cd
mkmountpoint /sqsh
mkmountpoint /ext3fs
mount /dev/sda /cd
mount-loop /cd/LiveOS/squashfs.img /sqsh
mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs

The inner filesystem is now unpacked under the /ext3fs mountpoint.

"guestfs_mkmountpoint" is not compatible with "guestfs_umount_all". You may get unexpected errors if you try to mix these calls. It is safest to manually unmount filesystems and remove mountpoints after use.

"guestfs_umount_all" unmounts filesystems by sorting the paths longest first, so for this to work for manual mountpoints, you must ensure that the innermost mountpoints have the longest pathnames, as in the example code above. 詳 細 は https://bugzilla.redhat.com/show_bug.cgi?id=599503 を 参 照 し て く だ さ い

Autosync [see "guestfs_set_autosync", this is set by default on handles] can cause "guestfs_umount_all" to be called when the handle is closed which can also trigger these issues. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.62 に お い て 追 加 )

guestfs_mknod
int
guestfs_mknod (guestfs_h *g,
int mode,
int devmajor,
int devminor,
const char *path);

This call creates block or character special devices, or named pipes (FIFOs).

The "mode" parameter should be the mode, using the standard constants. "devmajor" and "devminor" are the device major and minor numbers, only used when creating block and character special devices.

Note that, just like mknod(2), the mode must be bitwise OR’d with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a regular file). These constants are available in the standard Linux header files, or you can use "guestfs_mknod_b", "guestfs_mknod_c" or "guestfs_mkfifo" which are wrappers around this command which bitwise OR in the appropriate constant for you. 実 際 に 設 定 さ れ る モ ー ド は umask に よ り 影 響 さ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mknod". See also "guestfs_feature_available".

(1.0.55 に お い て 追 加 )

guestfs_mknod_b
int
guestfs_mknod_b (guestfs_h *g,
int mode,
int devmajor,
int devminor,
const char *path);

This call creates a block device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". It is just a convenient wrapper around "guestfs_mknod".

Unlike with "guestfs_mknod", "mode" must contain only permissions bits. 実 際 に 設 定 さ れ る モ ー ド は umask に よ り 影 響 さ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mknod". See also "guestfs_feature_available".

(1.0.55 に お い て 追 加 )

guestfs_mknod_c
int
guestfs_mknod_c (guestfs_h *g,
int mode,
int devmajor,
int devminor,
const char *path);

This call creates a char device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". It is just a convenient wrapper around "guestfs_mknod".

Unlike with "guestfs_mknod", "mode" must contain only permissions bits. 実 際 に 設 定 さ れ る モ ー ド は umask に よ り 影 響 さ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "mknod". See also "guestfs_feature_available".

(1.0.55 に お い て 追 加 )

guestfs_mksquashfs
int
guestfs_mksquashfs (guestfs_h *g,
const char *path,
const char *filename,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKSQUASHFS_COMPRESS, const char *compress,
GUESTFS_MKSQUASHFS_EXCLUDES, char *const *excludes,

Create a squashfs filesystem for the specified "path".

The optional "compress" flag controls compression. If not given, then the output compressed using "gzip". Otherwise one of the following strings may be given to select the compression type of the squashfs: "gzip", "lzma", "lzo", "lz4", "xz".

The other optional arguments are:
"excludes"

A list of wildcards. Files are excluded if they match any of the wildcards.

Please note that this API may fail when used to compress directories with large files, such as the resulting squashfs will be over 3GB big. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "squashfs". See also "guestfs_feature_available".

(Added in 1.35.25)

guestfs_mksquashfs_va
int
guestfs_mksquashfs_va (guestfs_h *g,
const char *path,
const char *filename,
va_list args);

This is the "va_list variant" of "guestfs_mksquashfs".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mksquashfs_argv
int
guestfs_mksquashfs_argv (guestfs_h *g,
const char *path,
const char *filename,
const struct guestfs_mksquashfs_argv *optargs);

This is the "argv variant" of "guestfs_mksquashfs".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkswap
int
guestfs_mkswap (guestfs_h *g,
const char *device);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_mkswap_opts" with no optional arguments.

(1.0.55 に お い て 追 加 )

guestfs_mkswap_opts
int
guestfs_mkswap_opts (guestfs_h *g,
const char *device,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKSWAP_OPTS_LABEL, const char *label,
GUESTFS_MKSWAP_OPTS_UUID, const char *uuid,

Linux swap パ ー テ ィ シ ョ ン を "device" に 作 成 し ま す 。

The option arguments "label" and "uuid" allow you to set the label and/or UUID of the new swap partition. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.55 に お い て 追 加 )

guestfs_mkswap_opts_va
int
guestfs_mkswap_opts_va (guestfs_h *g,
const char *device,
va_list args); こ れ は "guestfs_mkswap_opts" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkswap_opts_argv
int
guestfs_mkswap_opts_argv (guestfs_h *g,
const char *device,
const struct guestfs_mkswap_opts_argv *optargs); こ れ は "guestfs_mkswap_opts" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mkswap_L
int
guestfs_mkswap_L (guestfs_h *g,
const char *label,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mkswap" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions. ラ ベ ル "label" を 持 つ "device" に swap パ ー テ ィ シ ョ ン を 作 成 し ま す 。

Note that you cannot attach a swap label to a block device (eg. /dev/sda), just to a partition. This appears to be a limitation of the kernel or swap tools. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.55 に お い て 追 加 )

guestfs_mkswap_U
int
guestfs_mkswap_U (guestfs_h *g,
const char *uuid,
const char *device); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_mkswap" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

UUID "uuid" の "device" に swap パ ー テ ィ シ ョ ン を 作 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxfsuuid". See also "guestfs_feature_available".

(1.0.55 に お い て 追 加 )

guestfs_mkswap_file
int
guestfs_mkswap_file (guestfs_h *g,
const char *path);

swap フ ァ イ ル を 作 成 し ま す 。

This command just writes a swap file signature to an existing file. To create the file itself, use something like "guestfs_fallocate". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.66 に お い て 追 加 )

guestfs_mktemp
char *
guestfs_mktemp (guestfs_h *g,
const char *tmpl,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MKTEMP_SUFFIX, const char *suffix,

This command creates a temporary file. The "tmpl" parameter should be a full pathname for the temporary directory name with the final six characters being "XXXXXX". 例 : "/tmp/myprogXXXXXX" ま た は "/Temp/myprogXXXXXX"、 2 つ め の 例 は Windows フ ァ イ ル シ ス テ ム に 適 し て い ま す 。

The name of the temporary file that was created is returned.

The temporary file is created with mode 0600 and is owned by root.

The caller is responsible for deleting the temporary file after use.

If the optional "suffix" parameter is given, then the suffix (eg. ".txt") is appended to the temporary name. 関 連 項 目 : "guestfs_mkdtemp". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.19.53 に お い て 追 加 )

guestfs_mktemp_va
char *
guestfs_mktemp_va (guestfs_h *g,
const char *tmpl,
va_list args); こ れ は "guestfs_mktemp" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mktemp_argv
char *
guestfs_mktemp_argv (guestfs_h *g,
const char *tmpl,
const struct guestfs_mktemp_argv *optargs); こ れ は "guestfs_mktemp" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_modprobe
int
guestfs_modprobe (guestfs_h *g,
const char *modulename); ア プ ラ イ ア ン ス に カ ー ネ ル モ ジ ュ ー ル を 読 み 込 み ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxmodules". See also "guestfs_feature_available".

(1.0.68 に お い て 追 加 )

guestfs_mount
int
guestfs_mount (guestfs_h *g,
const char *mountable,
const char *mountpoint);

Mount a guest disk at a position in the filesystem. Block devices are named /dev/sda, /dev/sdb and so on, as they were added to the guest. If those block devices contain partitions, they will have the usual names (eg. /dev/sda1). Also LVM /dev/VG/LV-style names can be used, or ’mountable’ strings returned by "guestfs_list_filesystems" or "guestfs_inspect_get_mountpoints".

The rules are the same as for mount(2): A filesystem must first be mounted on / before others can be mounted. Other filesystems can only be mounted on directories which already exist.

The mounted filesystem is writable, if we have sufficient permissions on the underlying device.

Before libguestfs 1.13.16, this call implicitly added the options "sync" and "noatime". The "sync" option greatly slowed writes and caused many problems for users. If your program might need to work with older versions of libguestfs, use "guestfs_mount_options" instead (using an empty string for the first parameter if you don’t want any options). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(0.3 に お い て 追 加 )

guestfs_mount_9p
int
guestfs_mount_9p (guestfs_h *g,
const char *mounttag,
const char *mountpoint,
...);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MOUNT_9P_OPTIONS, const char *options,

This call does nothing and returns an error. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.11.12 に お い て 追 加 )

guestfs_mount_9p_va
int
guestfs_mount_9p_va (guestfs_h *g,
const char *mounttag,
const char *mountpoint,
va_list args); こ れ は "guestfs_mount_9p" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mount_9p_argv
int
guestfs_mount_9p_argv (guestfs_h *g,
const char *mounttag,
const char *mountpoint,
const struct guestfs_mount_9p_argv *optargs); こ れ は "guestfs_mount_9p" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mount_local
int
guestfs_mount_local (guestfs_h *g,
const char *localmountpoint,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_MOUNT_LOCAL_READONLY, int readonly,
GUESTFS_MOUNT_LOCAL_OPTIONS, const char *options,
GUESTFS_MOUNT_LOCAL_CACHETIMEOUT, int cachetimeout,
GUESTFS_MOUNT_LOCAL_DEBUGCALLS, int debugcalls,

This call exports the libguestfs-accessible filesystem to a local mountpoint (directory) called "localmountpoint". Ordinary reads and writes to files and directories under "localmountpoint" are redirected through libguestfs.

If the optional "readonly" flag is set to true, then writes to the filesystem return error "EROFS".

"options" is a comma-separated list of mount options. See guestmount(1) for some useful options.

"cachetimeout" sets the timeout (in seconds) for cached directory entries. The default is 60 seconds. See guestmount(1) for further information.

If "debugcalls" is set to true, then additional debugging information is generated for every FUSE call.

When "guestfs_mount_local" returns, the filesystem is ready, but is not processing requests (access to it will block). You have to call "guestfs_mount_local_run" to run the main loop. 完 全 な ド キ ュ メ ン ト は "MOUNT LOCAL" を 参 照 し て く だ さ い 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.17.22 に お い て 追 加 )

guestfs_mount_local_va
int
guestfs_mount_local_va (guestfs_h *g,
const char *localmountpoint,
va_list args); こ れ は "guestfs_mount_local" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mount_local_argv
int
guestfs_mount_local_argv (guestfs_h *g,
const char *localmountpoint,
const struct guestfs_mount_local_argv *optargs); こ れ は "guestfs_mount_local" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_mount_local_run
int
guestfs_mount_local_run (guestfs_h *g);

Run the main loop which translates kernel calls to libguestfs calls.

This should only be called after "guestfs_mount_local" returns successfully. The call will not return until the filesystem is unmounted.

Note you must not make concurrent libguestfs calls on the same handle from another thread.

You may call this from a different thread than the one which called "guestfs_mount_local", subject to the usual rules for threads and libguestfs (see "MULTIPLE HANDLES AND MULTIPLE THREADS"). 完 全 な ド キ ュ メ ン ト は "MOUNT LOCAL" を 参 照 し て く だ さ い 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.17.22 に お い て 追 加 )

guestfs_mount_loop
int
guestfs_mount_loop (guestfs_h *g,
const char *file,
const char *mountpoint);

This command lets you mount file (a filesystem image in a file) on a mount point. It is entirely equivalent to the command "mount -o loop file mountpoint". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.54 に お い て 追 加 )

guestfs_mount_options
int
guestfs_mount_options (guestfs_h *g,
const char *options,
const char *mountable,
const char *mountpoint);

This is the same as the "guestfs_mount" command, but it allows you to set the mount options as for the mount(8) -o flag.

If the "options" parameter is an empty string, then no options are passed (all options default to whatever the filesystem uses). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.10 に お い て 追 加 )

guestfs_mount_ro
int
guestfs_mount_ro (guestfs_h *g,
const char *mountable,
const char *mountpoint);

This is the same as the "guestfs_mount" command, but it mounts the filesystem with the read-only (-o ro) flag. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.10 に お い て 追 加 )

guestfs_mount_vfs
int
guestfs_mount_vfs (guestfs_h *g,
const char *options,
const char *vfstype,
const char *mountable,
const char *mountpoint);

This is the same as the "guestfs_mount" command, but it allows you to set both the mount options and the vfstype as for the mount(8) -o and -t flags. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.10 に お い て 追 加 )

guestfs_mountable_device
char *
guestfs_mountable_device (guestfs_h *g,
const char *mountable);

Returns the device name of a mountable. In quite a lot of cases, the mountable is the device name.

However this doesn’t apply for btrfs subvolumes, where the mountable is a combination of both the device name and the subvolume path (see also "guestfs_mountable_subvolume" to extract the subvolume path of the mountable if any). こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.33.15)

guestfs_mountable_subvolume
char *
guestfs_mountable_subvolume (guestfs_h *g,
const char *mountable);

Returns the subvolume path of a mountable. Btrfs subvolumes mountables are a combination of both the device name and the subvolume path (see also "guestfs_mountable_device" to extract the device of the mountable).

If the mountable does not represent a btrfs subvolume, then this function fails and the "errno" is set to "EINVAL". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.33.15)

guestfs_mountpoints
char **
guestfs_mountpoints (guestfs_h *g);

This call is similar to "guestfs_mounts". That call returns a list of devices. This one returns a hash table (map) of device name to directory where the device is mounted.

This function returns a NULL-terminated array of strings, or NULL if there was an error. The array of strings will always have length "2n+1", where "n" keys and values alternate, followed by the trailing NULL entry. The caller must free the strings and the array after use.

(1.0.62 に お い て 追 加 )

guestfs_mounts
char **
guestfs_mounts (guestfs_h *g);

This returns the list of currently mounted filesystems. It returns the list of devices (eg. /dev/sda1, /dev/VG/LV).

Some internal mounts are not shown. 関 連 項 目 : "guestfs_mountpoints"

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(0.8 に お い て 追 加 )

guestfs_mv
int
guestfs_mv (guestfs_h *g,
const char *src,
const char *dest);

This moves a file from "src" to "dest" where "dest" is either a destination filename or destination directory. 関 連 項 目 : "guestfs_rename"。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.18 に お い て 追 加 )

guestfs_nr_devices
int
guestfs_nr_devices (guestfs_h *g);

This returns the number of whole block devices that were added. This is the same as the number of devices that would be returned if you called "guestfs_list_devices".

To find out the maximum number of devices that could be added, call "guestfs_max_disks". こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.19.15 に お い て 追 加 )

guestfs_ntfs_3g_probe
int
guestfs_ntfs_3g_probe (guestfs_h *g,
int rw,
const char *device);

This command runs the ntfs-3g.probe(8) command which probes an NTFS "device" for mountability. (Not all NTFS volumes can be mounted read-write, and some cannot be mounted at all).

"rw" is a boolean flag. Set it to true if you want to test if the volume can be mounted read-write. Set it to false if you want to test if the volume can be mounted read-only.

The return value is an integer which 0 if the operation would succeed, or some non-zero value documented in the ntfs-3g.probe(8) manual page. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfs3g". See also "guestfs_feature_available".

(1.0.43 に お い て 追 加 )

guestfs_ntfscat_i
int
guestfs_ntfscat_i (guestfs_h *g,
const char *device,
int64_t inode,
const char *filename);

Download a file given its inode from a NTFS filesystem and save it as filename on the local machine.

This allows to download some otherwise inaccessible files such as the ones within the $Extend folder.

The filesystem from which to extract the file must be unmounted, otherwise the call will fail. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This long-running command can generate progress notification messages so that the caller can display a progress bar or indicator. To receive these messages, the caller must register a progress event callback. See "GUESTFS_EVENT_PROGRESS".

(Added in 1.33.14)

guestfs_ntfsclone_in
int
guestfs_ntfsclone_in (guestfs_h *g,
const char *backupfile,
const char *device);

"backupfile" を (前 に "guestfs_ntfsclone_out" を 呼 び 出 し た と こ ろ か ら ) "device" に 復 元 し ま す 。 こ の デ バ イ ス の 既 存 の 内 容 は す べ て 上 書 き さ れ ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfs3g". See also "guestfs_feature_available".

(1.17.9 に お い て 追 加 )

guestfs_ntfsclone_out
int
guestfs_ntfsclone_out (guestfs_h *g,
const char *device,
const char *backupfile,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_NTFSCLONE_OUT_METADATAONLY, int metadataonly,
GUESTFS_NTFSCLONE_OUT_RESCUE, int rescue,
GUESTFS_NTFSCLONE_OUT_IGNOREFSCHECK, int ignorefscheck,
GUESTFS_NTFSCLONE_OUT_PRESERVETIMESTAMPS, int preservetimestamps,
GUESTFS_NTFSCLONE_OUT_FORCE, int force,

Stream the NTFS filesystem "device" to the local file "backupfile". The format used for the backup file is a special format used by the ntfsclone(8) tool.

If the optional "metadataonly" flag is true, then only the metadata is saved, losing all the user data (this is useful for diagnosing some filesystem problems). オ プ シ ョ ン の "rescue", "ignorefscheck", "preservetimestamps" お よ び "force" フ ラ グ は ntfsclone(8) マ ニ ュ ア ル ペ ー ジ に 詳 細 な 意 味 が 説 明 さ れ て い ま す 。

libguestfs デ バ イ ス に フ ァ イ ル を 復 元 す る に は "guestfs_ntfsclone_in" を 使 用 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfs3g". See also "guestfs_feature_available".

(1.17.9 に お い て 追 加 )

guestfs_ntfsclone_out_va
int
guestfs_ntfsclone_out_va (guestfs_h *g,
const char *device,
const char *backupfile,
va_list args); こ れ は "guestfs_ntfsclone_out" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsclone_out_argv
int
guestfs_ntfsclone_out_argv (guestfs_h *g,
const char *device,
const char *backupfile,
const struct guestfs_ntfsclone_out_argv *optargs); こ れ は "guestfs_ntfsclone_out" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsfix
int
guestfs_ntfsfix (guestfs_h *g,
const char *device,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_NTFSFIX_CLEARBADSECTORS, int clearbadsectors, こ の コ マ ン ド は 、 い く つ か の 基 本 的 な NTFS の 不 整 合 を 修 復 し 、 NTFS ジ ャ ー ナ ル フ ァ イ ル を リ セ ッ ト し 、 次 回 Windows 起 動 時 に NTFS 完 全 性 チ ェ ッ ク を ス ケ ジ ュ ー ル 化 し ま す 。 こ れ は Windows の "chkdsk" と 同 等 で は あ り ま せ ん 。 不 整 合 に 対 し て フ ァ イ ル シ ス テ ム を ス キ ャ ン し ま せ ん 。 オ プ シ ョ ン の "clearbadsectors" フ ラ グ は 不 良 セ ク タ ー の 一 覧 を ク リ ア し ま す 。 不 良 セ ク タ ー を 持 つ デ ィ ス ク を 新 し い デ ィ ス ク に ク ロ ー ン し た 後 に 有 用 で す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfs3g". See also "guestfs_feature_available".

(1.17.9 に お い て 追 加 )

guestfs_ntfsfix_va
int
guestfs_ntfsfix_va (guestfs_h *g,
const char *device,
va_list args); こ れ は "guestfs_ntfsfix" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsfix_argv
int
guestfs_ntfsfix_argv (guestfs_h *g,
const char *device,
const struct guestfs_ntfsfix_argv *optargs); こ れ は "guestfs_ntfsfix" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsresize
int
guestfs_ntfsresize (guestfs_h *g,
const char *device);

This function is provided for backwards compatibility with earlier versions of libguestfs. It simply calls "guestfs_ntfsresize_opts" with no optional arguments.

(1.3.2 に お い て 追 加 )

guestfs_ntfsresize_opts
int
guestfs_ntfsresize_opts (guestfs_h *g,
const char *device,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,
GUESTFS_NTFSRESIZE_OPTS_FORCE, int force, こ の コ マ ン ド は NTFS フ ァ イ ル シ ス テ ム の 容 量 を 変 更 し ま す 。 基 礎 と な る デ バ イ ス の 容 量 ま で 拡 張 ま た は 縮 小 し ま す 。 オ プ シ ョ ン の パ ラ メ ー タ ー は 次 の と お り で す :
"size" フ ァ イ ル シ ス テ ム の 新 し い 容 量 (バ イ ト 単 位 )。 省 略 さ れ る と 、 フ ァ イ ル シ ス テ ム は コ ン テ ナ ー (例 : パ ー テ ィ シ ョ ン ) に 合 う よ う 容 量 を 変 更 さ れ ま す 。
"force"

If this option is true, then force the resize of the filesystem even if the filesystem is marked as requiring a consistency check.

After the resize operation, the filesystem is always marked as requiring a consistency check (for safety). You have to boot into Windows to perform this check and clear this condition. If you don’t set the "force" option then it is not possible to call "guestfs_ntfsresize" multiple times on a single filesystem without booting into Windows between each resize.

ntfsresize(8) 参 照 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfsprogs". See also "guestfs_feature_available".

(1.3.2 に お い て 追 加 )

guestfs_ntfsresize_opts_va
int
guestfs_ntfsresize_opts_va (guestfs_h *g,
const char *device,
va_list args); こ れ は "guestfs_ntfsresize_opts" の "va_list variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsresize_opts_argv
int
guestfs_ntfsresize_opts_argv (guestfs_h *g,
const char *device,
const struct guestfs_ntfsresize_opts_argv *optargs); こ れ は "guestfs_ntfsresize_opts" の "argv variant" で す 。

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_ntfsresize_size
int
guestfs_ntfsresize_size (guestfs_h *g,
const char *device,
int64_t size); こ の 関 数 は 推 奨 さ れ ま せ ん 。 新 し い コ ー ド で は 、 代 わ り に "guestfs_ntfsresize" を 使 用 し て く だ さ い 。

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This command is the same as "guestfs_ntfsresize" except that it allows you to specify the new size (in bytes) explicitly. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "ntfsprogs". See also "guestfs_feature_available".

(1.3.14 に お い て 追 加 )

guestfs_parse_environment
int
guestfs_parse_environment (guestfs_h *g);

Parse the program’s environment and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" then the ’verbose’ flag is set in the handle.

Most programs do not need to call this. It is done implicitly when you call "guestfs_create".

See "ENVIRONMENT VARIABLES" for a list of environment variables that can affect libguestfs handles. See also "guestfs_create_flags", and "guestfs_parse_environment_list". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.53 に お い て 追 加 )

guestfs_parse_environment_list
int
guestfs_parse_environment_list (guestfs_h *g,
char *const *environment);

Parse the list of strings in the argument "environment" and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" is a string in the list, then the ’verbose’ flag is set in the handle.

This is the same as "guestfs_parse_environment" except that it parses an explicit list of strings instead of the program’s environment. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.53 に お い て 追 加 )

guestfs_part_add
int
guestfs_part_add (guestfs_h *g,
const char *device,
const char *prlogex,
int64_t startsect,
int64_t endsect);

This command adds a partition to "device". If there is no partition table on the device, call "guestfs_part_init" first.

The "prlogex" parameter is the type of partition. Normally you should pass "p" or "primary" here, but MBR partition tables also support "l" (or "logical") and "e" (or "extended") partition types.

"startsect" and "endsect" are the start and end of the partition in sectors. "endsect" may be negative, which means it counts backwards from the end of the disk (-1 is the last sector).

Creating a partition which covers the whole disk is not so easy. Use "guestfs_part_disk" to do that. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_del
int
guestfs_part_del (guestfs_h *g,
const char *device,
int partnum); こ の コ マ ン ド は "device" に あ る "partnum" 番 の パ ー テ ィ シ ョ ン を 削 除 し ま す 。

Note that in the case of MBR partitioning, deleting an extended partition also deletes any logical partitions it contains. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.3.2 に お い て 追 加 )

guestfs_part_disk
int
guestfs_part_disk (guestfs_h *g,
const char *device,
const char *parttype);

This command is simply a combination of "guestfs_part_init" followed by "guestfs_part_add" to create a single primary partition covering the whole disk.

"parttype" is the partition table type, usually "mbr" or "gpt", but other possible values are described in "guestfs_part_init". こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_expand_gpt
int
guestfs_part_expand_gpt (guestfs_h *g,
const char *device);

Move backup GPT data structures to the end of the disk. This is useful in case of in-place image expand since disk space after backup GPT header is not usable. This is equivalent to "sgdisk -e".

See also sgdisk(8). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.33.2)

guestfs_part_get_bootable
int
guestfs_part_get_bootable (guestfs_h *g,
const char *device,
int partnum);

"device" に あ る パ ー テ ィ シ ョ ン "partnum" に ブ ー ト 可 能 フ ラ グ が 設 定 さ れ て い る と 、 こ の コ マ ン ド は 真 を 返 し ま す 。

"guestfs_part_set_bootable" 参 照 。

This function returns a C truth value on success or -1 on error.

(1.3.2 に お い て 追 加 )

guestfs_part_get_disk_guid
char *
guestfs_part_get_disk_guid (guestfs_h *g,
const char *device);

Return the disk identifier (GUID) of a GPT-partitioned "device". Behaviour is undefined for other partition types. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.33.2)

guestfs_part_get_gpt_attributes
int64_t
guestfs_part_get_gpt_attributes (guestfs_h *g,
const char *device,
int partnum);

Return the attribute flags of numbered GPT partition "partnum". An error is returned for MBR partitions. こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(1.21.1 に お い て 追 加 )

guestfs_part_get_gpt_guid
char *
guestfs_part_get_gpt_guid (guestfs_h *g,
const char *device,
int partnum);

Return the GUID of numbered GPT partition "partnum". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.29.25)

guestfs_part_get_gpt_type
char *
guestfs_part_get_gpt_type (guestfs_h *g,
const char *device,
int partnum);

Return the type GUID of numbered GPT partition "partnum". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(1.21.1 に お い て 追 加 )

guestfs_part_get_mbr_id
int
guestfs_part_get_mbr_id (guestfs_h *g,
const char *device,
int partnum);

Returns the MBR type byte (also known as the ID byte) from the numbered partition "partnum".

Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "guestfs_part_get_parttype"). こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.3.2 に お い て 追 加 )

guestfs_part_get_mbr_part_type
char *
guestfs_part_get_mbr_part_type (guestfs_h *g,
const char *device,
int partnum);

This returns the partition type of an MBR partition numbered "partnum" on device "device".

It returns "primary", "logical", or "extended". こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.29.32)

guestfs_part_get_name
char *
guestfs_part_get_name (guestfs_h *g,
const char *device,
int partnum);

This gets the partition name on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.

The partition name can only be read on certain types of partition table. This works on "gpt" but not on "mbr" partitions. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(Added in 1.25.33)

guestfs_part_get_parttype
char *
guestfs_part_get_parttype (guestfs_h *g,
const char *device);

This command examines the partition table on "device" and returns the partition table type (format) being used.

Common return values include: "msdos" (a DOS/Windows style MBR partition table), "gpt" (a GPT/EFI-style partition table). Other values are possible, although unusual. See "guestfs_part_init" for a full list. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_init
int
guestfs_part_init (guestfs_h *g,
const char *device,
const char *parttype);

This creates an empty partition table on "device" of one of the partition types listed below. Usually "parttype" should be either "msdos" or "gpt" (for large disks).

Initially there are no partitions. Following this, you should call "guestfs_part_add" for each partition required.

Possible values for "parttype" are:
"efi"
"gpt"

Intel EFI / GPT パ ー テ ィ シ ョ ン テ ー ブ ル 。

This is recommended for >= 2 TB partitions that will be accessed from Linux and Intel-based Mac OS X. It also has limited backwards compatibility with the "mbr" format.

"mbr"
"msdos"

The standard PC "Master Boot Record" (MBR) format used by MS-DOS and Windows. This partition type will only work for device sizes up to 2 TB. For large disks we recommend using "gpt".

Other partition table types that may work but are not supported include:
"aix"

AIX デ ィ ス ク ラ ベ ル 。

"amiga"
"rdb"

Amiga "Rigid Disk Block" 形 式 。

"bsd"

BSD デ ィ ス ク ラ ベ ル .

"dasd"

DASD, IBM メ イ ン フ レ ー ム に お い て 使 用 .

"dvh"

MIPS/SGI ボ リ ュ ー ム .

"mac" 古 い Mac パ ー テ ィ シ ョ ン 形 式 。 最 近 の Mac は "gpt" を 使 用 し ま す 。
"pc98"

NEC PC-98 形 式 。 日 本 に お い て 一 般 的 に 見 ら れ ま す 。

"sun"

Sun デ ィ ス ク ラ ベ ル こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_list
struct guestfs_partition_list *
guestfs_part_list (guestfs_h *g,
const char *device);

This command parses the partition table on "device" and returns the list of partitions found.

The fields in the returned structure are:
"part_num" パ ー テ ィ シ ョ ン 番 号 。 1 か ら 数 え ま す 。
"part_start"

Start of the partition in bytes. To get sectors you have to divide by the device’s sector size, see "guestfs_blockdev_getss".

"part_end" バ イ ト 単 位 の パ ー テ ィ シ ョ ン の 終 了 位 置 。
"part_size" バ イ ト 単 位 の パ ー テ ィ シ ョ ン 容 量 。

This function returns a "struct guestfs_partition_list *", or NULL if there was an error. The caller must call "guestfs_free_partition_list" after use.

(1.0.78 に お い て 追 加 )

guestfs_part_resize
int
guestfs_part_resize (guestfs_h *g,
const char *device,
int partnum,
int64_t endsect);

This command resizes the partition numbered "partnum" on "device" by moving the end position.

Note that this does not modify any filesystem present in the partition. If you wish to do this, you will need to use filesystem resizing commands like "guestfs_resize2fs".

When growing a partition you will want to grow the filesystem afterwards, but when shrinking, you need to shrink the filesystem before the partition. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(Added in 1.37.20)

guestfs_part_set_bootable
int
guestfs_part_set_bootable (guestfs_h *g,
const char *device,
int partnum,
int bootable); デ バ イ ス "device" の パ ー テ ィ シ ョ ン 番 号 "partnum" に ブ ー ト 可 能 フ ラ グ を 設 定 し ま す 。 パ ー テ ィ シ ョ ン は 1 か ら 番 号 が 始 ま る こ と に 注 意 し て く だ さ い 。

The bootable flag is used by some operating systems (notably Windows) to determine which partition to boot from. It is by no means universally recognized. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_set_disk_guid
int
guestfs_part_set_disk_guid (guestfs_h *g,
const char *device,
const char *guid);

Set the disk identifier (GUID) of a GPT-partitioned "device" to "guid". Return an error if the partition table of "device" isn’t GPT, or if "guid" is not a valid GUID. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.33.2)

guestfs_part_set_disk_guid_random
int
guestfs_part_set_disk_guid_random (guestfs_h *g,
const char *device);

Set the disk identifier (GUID) of a GPT-partitioned "device" to a randomly generated value. Return an error if the partition table of "device" isn’t GPT. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.33.2)

guestfs_part_set_gpt_attributes
int
guestfs_part_set_gpt_attributes (guestfs_h *g,
const char *device,
int partnum,
int64_t attributes);

Set the attribute flags of numbered GPT partition "partnum" to "attributes". Return an error if the partition table of "device" isn’t GPT.

See https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_entries for a useful list of partition attributes. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(1.21.1 に お い て 追 加 )

guestfs_part_set_gpt_guid
int
guestfs_part_set_gpt_guid (guestfs_h *g,
const char *device,
int partnum,
const char *guid);

Set the GUID of numbered GPT partition "partnum" to "guid". Return an error if the partition table of "device" isn’t GPT, or if "guid" is not a valid GUID. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(Added in 1.29.25)

guestfs_part_set_gpt_type
int
guestfs_part_set_gpt_type (guestfs_h *g,
const char *device,
int partnum,
const char *guid);

Set the type GUID of numbered GPT partition "partnum" to "guid". Return an error if the partition table of "device" isn’t GPT, or if "guid" is not a valid GUID.

See https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs for a useful list of type GUIDs. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "gdisk". See also "guestfs_feature_available".

(1.21.1 に お い て 追 加 )

guestfs_part_set_mbr_id
int
guestfs_part_set_mbr_id (guestfs_h *g,
const char *device,
int partnum,
int idbyte);

Sets the MBR type byte (also known as the ID byte) of the numbered partition "partnum" to "idbyte". Note that the type bytes quoted in most documentation are in fact hexadecimal numbers, but usually documented without any leading "0x" which might be confusing.

Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "guestfs_part_get_parttype"). こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.3.2 に お い て 追 加 )

guestfs_part_set_name
int
guestfs_part_set_name (guestfs_h *g,
const char *device,
int partnum,
const char *name);

This sets the partition name on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.

The partition name can only be set on certain types of partition table. This works on "gpt" but not on "mbr" partitions. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.78 に お い て 追 加 )

guestfs_part_to_dev
char *
guestfs_part_to_dev (guestfs_h *g,
const char *partition);

This function takes a partition name (eg. "/dev/sdb1") and removes the partition number, returning the device name (eg. "/dev/sdb").

The named partition must exist, for example as a string returned from "guestfs_list_partitions".

"guestfs_part_to_partnum", "guestfs_device_index" 参 照 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.5.15 に お い て 追 加 )

guestfs_part_to_partnum
int
guestfs_part_to_partnum (guestfs_h *g,
const char *partition);

This function takes a partition name (eg. "/dev/sdb1") and returns the partition number (eg. 1).

The named partition must exist, for example as a string returned from "guestfs_list_partitions".

"guestfs_part_to_dev" 参 照 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

(1.13.25 に お い て 追 加 )

guestfs_ping_daemon
int
guestfs_ping_daemon (guestfs_h *g);

This is a test probe into the guestfs daemon running inside the libguestfs appliance. Calling this function checks that the daemon responds to the ping message, without affecting the daemon or attached block device(s) in any other way. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.0.18 に お い て 追 加 )

guestfs_pread
char *
guestfs_pread (guestfs_h *g,
const char *path,
int count,
int64_t offset,
size_t *size_r);

This command lets you read part of a file. It reads "count" bytes of the file, starting at "offset", from file "path".

This may read fewer bytes than requested. For further details see the pread(2) system call.

"guestfs_pwrite", "guestfs_pread_device" 参 照 。

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.0.77 に お い て 追 加 )

guestfs_pread_device
char *
guestfs_pread_device (guestfs_h *g,
const char *device,
int count,
int64_t offset,
size_t *size_r);

This command lets you read part of a block device. It reads "count" bytes of "device", starting at "offset".

This may read fewer bytes than requested. For further details see the pread(2) system call.

"guestfs_pread" 参 照 。

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.5.21 に お い て 追 加 )

guestfs_pvchange_uuid
int
guestfs_pvchange_uuid (guestfs_h *g,
const char *device); 物 理 ボ リ ュ ー ム "device" に 対 す る 新 し い ラ ン ダ ム な UUID を 生 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.19.26 に お い て 追 加 )

guestfs_pvchange_uuid_all
int
guestfs_pvchange_uuid_all (guestfs_h *g); す べ て の 物 理 ボ リ ュ ー ム に 対 す る 新 し い ラ ン ダ ム な UUID を 生 成 し ま す 。 こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.19.26 に お い て 追 加 )

guestfs_pvcreate
int
guestfs_pvcreate (guestfs_h *g,
const char *device);

This creates an LVM physical volume on the named "device", where "device" should usually be a partition name such as /dev/sda1. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.8 に お い て 追 加 )

guestfs_pvremove
int
guestfs_pvremove (guestfs_h *g,
const char *device);

This wipes a physical volume "device" so that LVM will no longer recognise it.

The implementation uses the pvremove(8) command which refuses to wipe physical volumes that contain any volume groups, so you have to remove those first. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.0.13 に お い て 追 加 )

guestfs_pvresize
int
guestfs_pvresize (guestfs_h *g,
const char *device);

This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.0.26 に お い て 追 加 )

guestfs_pvresize_size
int
guestfs_pvresize_size (guestfs_h *g,
const char *device,
int64_t size);

This command is the same as "guestfs_pvresize" except that it allows you to specify the new size (in bytes) explicitly. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(1.3.14 に お い て 追 加 )

guestfs_pvs
char **
guestfs_pvs (guestfs_h *g);

List all the physical volumes detected. This is the equivalent of the pvs(8) command.

This returns a list of just the device names that contain PVs (eg. /dev/sda2).

"guestfs_pvs_full" 参 照 。

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.4 に お い て 追 加 )

guestfs_pvs_full
struct guestfs_lvm_pv_list *
guestfs_pvs_full (guestfs_h *g);

List all the physical volumes detected. This is the equivalent of the pvs(8) command. The "full" version includes all fields.

This function returns a "struct guestfs_lvm_pv_list *", or NULL if there was an error. The caller must call "guestfs_free_lvm_pv_list" after use.

This function depends on the feature "lvm2". See also "guestfs_feature_available".

(0.4 に お い て 追 加 )

guestfs_pvuuid
char *
guestfs_pvuuid (guestfs_h *g,
const char *device); こ の コ マ ン ド は LVM PV "device" の UUID を 返 し ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.87 に お い て 追 加 )

guestfs_pwrite
int
guestfs_pwrite (guestfs_h *g,
const char *path,
const char *content,
size_t content_size,
int64_t offset);

This command writes to part of a file. It writes the data buffer "content" to the file "path" starting at offset "offset".

This command implements the pwrite(2) system call, and like that system call it may not write the full data requested. The return value is the number of bytes that were actually written to the file. This could even be 0, although short writes are unlikely for regular files in ordinary circumstances.

"guestfs_pread", "guestfs_pwrite_device" 参 照 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.3.14 に お い て 追 加 )

guestfs_pwrite_device
int
guestfs_pwrite_device (guestfs_h *g,
const char *device,
const char *content,
size_t content_size,
int64_t offset);

This command writes to part of a device. It writes the data buffer "content" to "device" starting at offset "offset".

This command implements the pwrite(2) system call, and like that system call it may not write the full data requested (although short writes to disk devices and partitions are probably impossible with standard Linux kernels).

"guestfs_pwrite" 参 照 。 こ の 関 数 は エ ラ ー の と き -1 を 返 し ま す 。

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS".

(1.5.20 に お い て 追 加 )

guestfs_read_file
char *
guestfs_read_file (guestfs_h *g,
const char *path,
size_t *size_r);

This calls returns the contents of the file "path" as a buffer.

Unlike "guestfs_cat", this function can correctly handle files that contain embedded ASCII NUL characters.

This function returns a buffer, or NULL on error. The size of the returned buffer is written to *size_r. The caller must free the returned buffer after use.

(1.0.63 に お い て 追 加 )

guestfs_read_lines
char **
guestfs_read_lines (guestfs_h *g,
const char *path);

"path" と い う 名 前 の フ ァ イ ル の 内 容 を 返 し ま す 。

The file contents are returned as a list of lines. Trailing "LF" and "CRLF" character sequences are not returned.

Note that this function cannot correctly handle binary files (specifically, files containing "\0" character which is treated as end of string). For those you need to use the "guestfs_read_file" function and split the buffer into lines yourself.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(0.7 に お い て 追 加 )

guestfs_readdir
struct guestfs_dirent_list *
guestfs_readdir (guestfs_h *g,
const char *dir);

This returns the list of directory entries in directory "dir".

All entries in the directory are returned, including "." and "..". The entries are not sorted, but returned in the same order as the underlying filesystem.

Also this call returns basic file type information about each file. The "ftyp" field will contain one of the following characters:

FIFO (名 前 付 き パ イ プ )

The readdir(3) call returned a "d_type" field with an unexpected value

This function is primarily intended for use by programs. To get a simple list of names, use "guestfs_ls". To get a printable directory for human consumption, use "guestfs_ll". こ の 関 数 は "struct guestfs_dirent_list *" を 返 し ま す 。 も し く は 、 エ ラ ー が 発 生 す る と NULL を 返 し ま す 。 呼 び 出 し 元 は 使 用 後 に "guestfs_free_dirent_list" を 呼 び 出 す 必 要 が あ り ま す 。

This long-running command can generate progress notification messages so that the caller can display a progress bar or indicator. To receive these messages, the caller must register a progress event callback. See "GUESTFS_EVENT_PROGRESS".

(1.0.55 に お い て 追 加 )

guestfs_readlink
char *
guestfs_readlink (guestfs_h *g,
const char *path); こ の コ マ ン ド は シ ン ボ リ ッ ク リ ン ク の 参 照 先 を 読 み 込 み ま す 。 こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.66 に お い て 追 加 )

guestfs_readlinklist
char **
guestfs_readlinklist (guestfs_h *g,
const char *path,
char *const *names);

This call allows you to do a "readlink" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a list of strings, with a one-to-one correspondence to the "names" list. Each string is the value of the symbolic link.

If the readlink(2) operation fails on any name, then the corresponding result string is the empty string "". However the whole operation is completed even if there were readlink(2) errors, and so you can call this function with names where you don’t know if they are symbolic links already (albeit slightly less efficient).

This call is intended for programs that want to efficiently list a directory contents without making many round-trips.

This function returns a NULL-terminated array of strings (like environ(3)), or NULL if there was an error. The caller must free the strings and the array after use.

(1.0.77 に お い て 追 加 )

guestfs_realpath
char *
guestfs_realpath (guestfs_h *g,
const char *path);

Return the canonicalized absolute pathname of "path". The returned path has no ".", ".." or symbolic link path elements. こ の 関 数 は 文 字 列 を 返 し ま す 。 エ ラ ー 時 は NULL で す 。 呼 び 出 し 元 は 使 用 後 に 返 さ れ た 文 字 列 を 開 放 す る 必 要 が あ り ま す 。

(1.0.66 に お い て 追 加 )

guestfs_remount
int
guestfs_remount (guestfs_h *g,
const char *mountpoint,
...);

You may supply a list of optional arguments to this call. Use zero or more of the following pairs of parameters, and terminate the list with -1 on its own. See "CALLS WITH OPTIONAL ARGUMENTS".

GUESTFS_REMOUNT_RW, int rw,

This call allows you to change the "rw" (readonly/read-write) flag on an already mounted filesystem at "mountpoint", converting a readonly filesystem to be read-write, or vice-versa.

Note that at the moment you must supply the "optional" "rw" parameter. In future we may allow other flags to be adjusted. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(Added in 1.23.2)

guestfs_remount_va
int
guestfs_remount_va (guestfs_h *g,
const char *mountpoint,
va_list args);

This is the "va_list variant" of "guestfs_remount".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_remount_argv
int
guestfs_remount_argv (guestfs_h *g,
const char *mountpoint,
const struct guestfs_remount_argv *optargs);

This is the "argv variant" of "guestfs_remount".

"CALLS WITH OPTIONAL ARGUMENTS" 参 照 。

guestfs_remove_drive
int
guestfs_remove_drive (guestfs_h *g,
const char *label);

This function is deprecated. There is no replacement. Consult the API documentation in guestfs(3) for further information.

Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.

This call does nothing and returns an error. こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

(1.19.49 に お い て 追 加 )

guestfs_removexattr
int
guestfs_removexattr (guestfs_h *g,
const char *xattr,
const char *path);

This call removes the extended attribute named "xattr" of the file "path". 関 連 項 目 : "guestfs_lremovexattr", attr(5) こ の 関 数 は 、 成 功 の と き 0 を 、 エ ラ ー の と き -1 を 返 し ま す 。

This function depends on the feature "linuxxattrs". See also "guestfs_feature_available".

(1.0.59 に お い て 追 加 )

guestfs_rename
int
guestfs_rename (guestfs_h *g,
const char *oldpath,
const char *newpath);