summaryrefslogtreecommitdiff
path: root/docs/manpages/virt-xml-validate.rst
blob: 503ddbd35a6b32fd91bd7fdfea7a6f4858dfe15b (plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
=================
virt-xml-validate
=================

-------------------------------------------
validate libvirt XML files against a schema
-------------------------------------------

:Manual section: 1
:Manual group: Virtualization Support

.. contents::

SYNOPSIS
========


``virt-xml-validate`` *XML-FILE* [*SCHEMA-NAME*]

``virt-xml-validate`` *OPTION*


DESCRIPTION
===========

Validates a libvirt XML for compliance with the published schema.
The first compulsory argument is the path to the XML file to be
validated. The optional second argument is the name of the schema
to validate against. If omitted, the schema name will be inferred
from the name of the root element in the XML document.

Valid schema names currently include

- ``cpu``

The schema for the XML format of cpu

- ``domainsnapshot``

The schema for the XML format used by domain snapshot configuration

- ``domaincheckpoint``

The schema for the XML format used by domain checkpoint configuration

- ``domainbackup``

The schema for the XML format used by domain backup configuration

- ``domaincaps``

The schema for the XML format of domain capabilities

- ``domain``

The schema for the XML format used by guest domains configuration

- ``networkport``

The schema for the XML format used by network port configuration

- ``network``

The schema for the XML format used by virtual network configuration

- ``storagepoolcaps``

The schema for the XML format of storage pool capabilities

- ``storagepool``

The schema for the XML format used by storage pool configuration

- ``storagevol``

The schema for the XML format used by storage volume descriptions

- ``nodedev``

The schema for the XML format used by node device descriptions

- ``capability``

The schema for the XML format used to declare driver capabilities

- ``nwfilter``

The schema for the XML format used by network traffic filters

- ``nwfilterbinding``

The schema for XML format used by network filter bindings.

- ``secret``

The schema for the XML format used by secrets descriptions

- ``interface``

The schema for the XML format used by physical host interfaces


OPTIONS
=======

``-h``, ``--help``

Display command line help usage then exit.

``-V``, ``--version``

Display version information then exit.


EXIT STATUS
===========

Upon successful validation, an exit status of 0 will be set. Upon
failure a non-zero status will be set.


AUTHOR
======

Daniel P. Berrangé


BUGS
====

Please report all bugs you discover.  This should be done via either:

#. the mailing list

   `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_

#. the bug tracker

   `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_

Alternatively, you may report bugs to your software distributor / vendor.


COPYRIGHT
=========

Copyright (C) 2009-2013 by Red Hat, Inc.
Copyright (C) 2009 by Daniel P. Berrangé


LICENSE
=======

``virt-xml-validate`` is distributed under the terms of the GNU GPL v2+.
This is free software; see the source for copying conditions. There
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE


SEE ALSO
========

virsh(1), `online XML format descriptions <https://libvirt.org/format.html>`_,
`https://libvirt.org/ <https://libvirt.org/>`_