.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Ocsinventory::Agent::XML::Inventory 3pm"
.TH Ocsinventory::Agent::XML::Inventory 3pm "2023-01-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Ocsinventory::Agent::XML::Inventory \- the XML abstraction layer
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1OCS\s0 Inventory uses \s-1XML\s0 for the data transmission. The module is the
abstraction layer. It's mostly used in the backend module where it
called \f(CW$inventory\fR in general.
.IP "\fBnew()\fR" 4
.IX Item "new()"
The usual constructor.
.IP "\fBinitialise()\fR" 4
.IX Item "initialise()"
Runs the backend modules to initialise the data.
.IP "\fBgetContent()\fR" 4
.IX Item "getContent()"
Return the inventory as a \s-1XML\s0 string.
.IP "\fBprintXML()\fR" 4
.IX Item "printXML()"
Only for debugging purpose. Print the inventory on \s-1STDOUT.\s0
.IP "\fBwriteXML()\fR" 4
.IX Item "writeXML()"
Save the generated inventory as an \s-1XML\s0 file. The 'local' key of the config
is used to know where the file as to be saved.
.IP "\fBprocessChecksum()\fR" 4
.IX Item "processChecksum()"
Compute the <\s-1CHECKSUM/\s0> field. This information is used by the server to
know which parts of the \s-1XML\s0 have changed since the last inventory.
.Sp
The is done thank to the last_file file. It has \s-1MD5\s0 prints of the previous
inventory.
.IP "\fBsaveLastState()\fR" 4
.IX Item "saveLastState()"
At the end of the process \s-1IF\s0 the inventory was saved
correctly, the last_state is saved.
.IP "\fBaddSection()\fR" 4
.IX Item "addSection()"
A generic way to save a section in the inventory. Please avoid this
solution.
.IP "\fBfeedSection()\fR" 4
.IX Item "feedSection()"
Add information in inventory.