Ocsinventory::Agent::XML::Inventory(3)

NAME
Ocsinventory::Agent::XML::Inventory - the XML abstraction layer

DESCRIPTION
OCS Inventory uses XML for the data transmition. The module is the abstraction layer. It's mostly used in the backend module where it called $inventory in general.

new()
    The usual constructor.

initialise()
    Runs the backend modules to initilise the data.

addController()
    Add a controller in the inventory.

addModem()
    Add a modem in the inventory.

addDrive()
    Add a partition in the inventory.

addStorages()
    Add a storage system (hard drive, USB key, SAN volume, etc) in the inventory.

addMemory()
    Add a memory module in the inventory.

addPort()
    Add a port module in the inventory.

addSlot()
    Add a slot in the inventory.

addSoftware()
    Register a software in the inventory.

addMonitor()
    Add a monitor (screen) in the inventory.

addVideo()
    Add a video card in the inventory.

addSound()
    Add a sound card in the inventory.

addNetwork()
    Register a network in the inventory.

setHardware()
    Save global information regarding the machine.

    The use of setHardware() to update USERID and PROCESSOR* informations is deprecated, please, use addUser() and addCPU() instead.

setBios()
    Set BIOS informations.

addCPU()
    Add a CPU in the inventory.

addUser()
    Add an user in the list of logged user.

addPrinter()
    Add a printer in the inventory.

addVirtualMachine()
    Add a Virtual Machine in the inventory.

addProcess()
    Record a running process in the inventory.

setAccessLog()
    What is that for? :)

addIpDiscoverEntry()
    IpDiscover is used to identify network interface on the local network. This is done on the ARP level.

    This function adds a network interface in the inventory.

getContent()
    Return the inventory as a XML string.

printXML()
    Only for debugging purpose. Print the inventory on STDOUT.

writeXML()
    Save the generated inventory as an XML file. The 'local' key of the config is used to know where the file as to be saved.

processChecksum()
    Compute the <CHECKSUM/> field. This information is used by the server to know which parts of the XML have changed since the last inventory.

    The is done thank to the last_file file. It has MD5 prints of the previous inventory.

saveLastState()
    At the end of the process IF the inventory was saved correctly, the last_state is saved.

addSection()
    A generic way to save a section in the inventory. Please avoid this solution.

feedSection()
    Add information in inventory.