File: man_VBoxManage-objtracker.xml

package info (click to toggle)
virtualbox 7.2.2-dfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: sid
  • size: 616,072 kB
  • sloc: cpp: 2,377,613; ansic: 2,351,258; asm: 379,359; python: 233,965; xml: 89,678; sh: 25,697; makefile: 8,169; perl: 5,697; java: 5,337; cs: 4,872; pascal: 1,785; javascript: 1,692; objc: 1,131; lex: 931; sed: 921; php: 906; yacc: 707
file content (111 lines) | stat: -rw-r--r-- 4,441 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage objtracker
-->
<!--
    Copyright (C) 2018-2025 Oracle and/or its affiliates.

    This file is part of VirtualBox base platform packages, as
    available from https://www.virtualbox.org.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, in version 3 of the
    License.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, see <https://www.gnu.org/licenses>.

    SPDX-License-Identifier: GPL-3.0-only
-->
<!--<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"    -->
<!--  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[       -->
<!--<!ENTITY % all.entities SYSTEM "all-entities.ent">                -->
<!--%all.entities;                                                    -->
<!--]>                                                                -->
<refentry id="vboxmanage-objtracker" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2025-08-11 19:18:47 +0200 (Mon, 11 Aug 2025) $</pubdate>
    <title>VBoxManage objtracker</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-objtracker</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-objtracker</refname>
    <refpurpose>Manage the tracked objects</refpurpose>
    <refclass>Oracle VirtualBox</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-objtracker-ifaces"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage objtracker</command>
        <arg choice="plain">ifaces</arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-objtracker-objlist">
      <command>VBoxManage objtracker</command>
      <arg choice="plain">objlist</arg>
      <arg choice="req">--ifacename=<replaceable>VirtualBox interface name</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis id="synopsis-vboxmanage-objtracker-objinfo">
      <command>VBoxManage objtracker</command>
      <arg choice="plain">objinfo</arg>
      <arg choice="req">--ifacename=<replaceable>VirtualBox interface name</replaceable></arg>
      <arg choice="req">--id=<replaceable>Unique object Id</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="vboxmanage-objtracker-description">
    <title>Description</title>

    <refsect2 id="vboxmanage-objtracker-ifaces">
      <title>objtracker ifaces</title>
      <remark role="help-copy-synopsis"/>
      <para>
        Shows the actual list of VirtualBox interfaces supported for tracking
      </para>
    </refsect2>

    <refsect2 id="vboxmanage-objtracker-objlist">
      <title>objtracker objlist</title>
      <remark role="help-copy-synopsis"/>
      <para>
        Shows the list of the unique identifiers of the tracked objects existing at moment for a specified interface
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--ifacename=<replaceable>vbox interface name</replaceable></option></term>
          <listitem><para>The name which fully identifies VitualBox interface aka IProgress, ISession, IMachine.</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="vboxmanage-objtracker-objinfo">
      <title>objtracker objinfo</title>
      <remark role="help-copy-synopsis"/>
      <para>
        Shows the information about the tracked object
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--ifacename=<replaceable>vbox interface name</replaceable></option></term>
          <listitem><para>The name which fully identifies VitualBox interface aka IProgress, ISession, IMachine.</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--id=<replaceable>unique object id</replaceable></option></term>
          <listitem><para>The unique identifer assigned to a tracked object by VirtualBox</para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>

</refentry>