addProductIdsToLicensePool

addProductIdsToLicensePool(productIds, licensePoolId)

  • Parameter: productIds

  • Parameter: licensePoolId

addSoftwareLicenseToLicensePool

addSoftwareLicenseToLicensePool(softwareLicenseId, licensePoolId, licenseKey="")

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

  • Parameter: licenseKey

    • Default: ""

areDepotsSynchronous

areDepotsSynchronous(depotIds=[])

  • Parameter: depotIds

    • Default: []

auditHardware_create

auditHardware_create(hardwareClass, kwargs)

  • Parameter: hardwareClass

  • Optional Parameter: kwargs

    • Type: dict

auditHardware_createObjects

auditHardware_createObjects(auditHardwares)

  • Parameter: auditHardwares

auditHardware_delete

auditHardware_delete(hardwareClass, kwargs)

  • Parameter: hardwareClass

  • Optional Parameter: kwargs

    • Type: dict

auditHardware_deleteObjects

auditHardware_deleteObjects(auditHardwares)

  • Parameter: auditHardwares

auditHardware_getConfig

auditHardware_getConfig(language=null)

  • Parameter: language

    • Default: null

auditHardware_getHashes

auditHardware_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditHardware_getIdents

auditHardware_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

auditHardware_getObjects

auditHardware_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditHardware_insertObject

auditHardware_insertObject(auditHardware)

  • Parameter: auditHardware

auditHardware_updateObject

auditHardware_updateObject(auditHardware)

  • Parameter: auditHardware

auditHardware_updateObjects

auditHardware_updateObjects(auditHardwares)

  • Parameter: auditHardwares

auditHardwareOnHost_create

auditHardwareOnHost_create(hostId, hardwareClass, firstseen=null, lastseen=null, state=null, kwargs)

  • Parameter: hostId

  • Parameter: hardwareClass

  • Parameter: firstseen

    • Default: null

  • Parameter: lastseen

    • Default: null

  • Parameter: state

    • Default: null

  • Optional Parameter: kwargs

    • Type: dict

auditHardwareOnHost_createObjects

auditHardwareOnHost_createObjects(auditHardwareOnHosts)

  • Parameter: auditHardwareOnHosts

auditHardwareOnHost_delete

auditHardwareOnHost_delete(hostId, hardwareClass, firstseen=null, lastseen=null, state=null, kwargs)

  • Parameter: hostId

  • Parameter: hardwareClass

  • Parameter: firstseen

    • Default: null

  • Parameter: lastseen

    • Default: null

  • Parameter: state

    • Default: null

  • Optional Parameter: kwargs

    • Type: dict

auditHardwareOnHost_deleteObjects

auditHardwareOnHost_deleteObjects(auditHardwareOnHosts)

  • Parameter: auditHardwareOnHosts

auditHardwareOnHost_getHashes

auditHardwareOnHost_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditHardwareOnHost_getIdents

auditHardwareOnHost_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

auditHardwareOnHost_getObjects

auditHardwareOnHost_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditHardwareOnHost_insertObject

auditHardwareOnHost_insertObject(auditHardwareOnHost)

  • Parameter: auditHardwareOnHost

auditHardwareOnHost_setObsolete

auditHardwareOnHost_setObsolete(hostId)

  • Parameter: hostId

auditHardwareOnHost_updateObject

auditHardwareOnHost_updateObject(auditHardwareOnHost)

Update an auditHardwareOnHost object. This will update the attributes state and lastseen on the object.

  • Parameter: auditHardwareOnHost

auditHardwareOnHost_updateObjects

auditHardwareOnHost_updateObjects(auditHardwareOnHosts)

  • Parameter: auditHardwareOnHosts

auditSoftware_create

auditSoftware_create(name, version, subVersion, language, architecture, windowsSoftwareId=null, windowsDisplayName=null, windowsDisplayVersion=null, installSize=null)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

  • Parameter: windowsSoftwareId

    • Default: null

  • Parameter: windowsDisplayName

    • Default: null

  • Parameter: windowsDisplayVersion

    • Default: null

  • Parameter: installSize

    • Default: null

auditSoftware_createObjects

auditSoftware_createObjects(auditSoftwares)

  • Parameter: auditSoftwares

auditSoftware_delete

auditSoftware_delete(name, version, subVersion, language, architecture)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

auditSoftware_deleteObjects

auditSoftware_deleteObjects(auditSoftwares)

  • Parameter: auditSoftwares

auditSoftware_getHashes

auditSoftware_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftware_getIdents

auditSoftware_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

auditSoftware_getObjects

auditSoftware_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftware_insertObject

auditSoftware_insertObject(auditSoftware)

  • Parameter: auditSoftware

auditSoftware_updateObject

auditSoftware_updateObject(auditSoftware)

  • Parameter: auditSoftware

auditSoftware_updateObjects

auditSoftware_updateObjects(auditSoftwares)

  • Parameter: auditSoftwares

auditSoftwareOnClient_create

auditSoftwareOnClient_create(name, version, subVersion, language, architecture, clientId, uninstallString=null, binaryName=null, firstseen=null, lastseen=null, state=null, usageFrequency=null, lastUsed=null, licenseKey=null)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

  • Parameter: clientId

  • Parameter: uninstallString

    • Default: null

  • Parameter: binaryName

    • Default: null

  • Parameter: firstseen

    • Default: null

  • Parameter: lastseen

    • Default: null

  • Parameter: state

    • Default: null

  • Parameter: usageFrequency

    • Default: null

  • Parameter: lastUsed

    • Default: null

  • Parameter: licenseKey

    • Default: null

auditSoftwareOnClient_createObjects

auditSoftwareOnClient_createObjects(auditSoftwareOnClients)

  • Parameter: auditSoftwareOnClients

auditSoftwareOnClient_delete

auditSoftwareOnClient_delete(name, version, subVersion, language, architecture, clientId)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

  • Parameter: clientId

auditSoftwareOnClient_deleteObjects

auditSoftwareOnClient_deleteObjects(auditSoftwareOnClients)

  • Parameter: auditSoftwareOnClients

auditSoftwareOnClient_getHashes

auditSoftwareOnClient_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftwareOnClient_getIdents

auditSoftwareOnClient_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

auditSoftwareOnClient_getObjects

auditSoftwareOnClient_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftwareOnClient_insertObject

auditSoftwareOnClient_insertObject(auditSoftwareOnClient)

  • Parameter: auditSoftwareOnClient

auditSoftwareOnClient_setObsolete

auditSoftwareOnClient_setObsolete(clientId)

  • Parameter: clientId

auditSoftwareOnClient_updateObject

auditSoftwareOnClient_updateObject(auditSoftwareOnClient)

  • Parameter: auditSoftwareOnClient

auditSoftwareOnClient_updateObjects

auditSoftwareOnClient_updateObjects(auditSoftwareOnClients)

  • Parameter: auditSoftwareOnClients

auditSoftwareToLicensePool_create

auditSoftwareToLicensePool_create(name, version, subVersion, language, architecture, licensePoolId)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

  • Parameter: licensePoolId

auditSoftwareToLicensePool_createObjects

auditSoftwareToLicensePool_createObjects(auditSoftwareToLicensePools)

  • Parameter: auditSoftwareToLicensePools

auditSoftwareToLicensePool_delete

auditSoftwareToLicensePool_delete(name, version, subVersion, language, architecture, licensePoolId)

  • Parameter: name

  • Parameter: version

  • Parameter: subVersion

  • Parameter: language

  • Parameter: architecture

  • Parameter: licensePoolId

auditSoftwareToLicensePool_deleteObjects

auditSoftwareToLicensePool_deleteObjects(auditSoftwareToLicensePools)

  • Parameter: auditSoftwareToLicensePools

auditSoftwareToLicensePool_getHashes

auditSoftwareToLicensePool_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftwareToLicensePool_getIdents

auditSoftwareToLicensePool_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

auditSoftwareToLicensePool_getObjects

auditSoftwareToLicensePool_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

auditSoftwareToLicensePool_insertObject

auditSoftwareToLicensePool_insertObject(auditSoftwareToLicensePool)

  • Parameter: auditSoftwareToLicensePool

auditSoftwareToLicensePool_updateObject

auditSoftwareToLicensePool_updateObject(auditSoftwareToLicensePool)

  • Parameter: auditSoftwareToLicensePool

auditSoftwareToLicensePool_updateObjects

auditSoftwareToLicensePool_updateObjects(auditSoftwareToLicensePools)

  • Parameter: auditSoftwareToLicensePools

authenticated

authenticated()

backend_createBase

backend_createBase()

Setting up the base for the backend to store its data. This can be something like creating a directory structure to setting up a databse.

backend_deleteBase

backend_deleteBase()

Deleting the base of the backend. This is the place to undo all the things that were created by backend_createBase.

backend_exit

backend_exit()

Exit the backend. This method should be used to close connections or clean up used resources.

backend_getInterface

backend_getInterface()

Returns what public methods are available and the signatures they use. These methods are represented as a dict with the following keys: name, params, args, varargs, keywords, defaults.

Returns [{},]

backend_getOptions

backend_getOptions()

Get the current backend options.

Returns dict

backend_getSystemConfiguration

backend_getSystemConfiguration()

Returns current system configuration. This holds information about server-side settings that may be relevant for clients. Under the key log information about log settings will be returned in form of a dict. In it under size_limit you will find the amount of bytes currently allowed as maximum log size. Under types you will find a list with currently supported log types.

Returns dict

backend_info

backend_info()

Get info about the used opsi version and the licensed modules.

Returns dict

backend_searchIdents

backend_searchIdents(filter)

  • Parameter: filter

backend_setOptions

backend_setOptions(options)

Set options on self and the extended backend.

  • Parameter: options

    • Type: dict

changeWANConfig

changeWANConfig(boolean, clientIds)

Change the WAN configuration.

  • Parameter: boolean

    • Type: bool

    • Description: Should the WAN config be enabled or not?

  • Parameter: clientIds

    • Description: The IDs of the clients where the setting should be changed.

config_create

config_create(id, description=null, possibleValues=null, defaultValues=null, editable=null, multiValue=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: possibleValues

    • Default: null

  • Parameter: defaultValues

    • Default: null

  • Parameter: editable

    • Default: null

  • Parameter: multiValue

    • Default: null

config_createBool

config_createBool(id, description=null, defaultValues=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: defaultValues

    • Default: null

config_createObjects

config_createObjects(configs)

  • Parameter: configs

config_createUnicode

config_createUnicode(id, description=null, possibleValues=null, defaultValues=null, editable=null, multiValue=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: possibleValues

    • Default: null

  • Parameter: defaultValues

    • Default: null

  • Parameter: editable

    • Default: null

  • Parameter: multiValue

    • Default: null

config_delete

config_delete(id)

  • Parameter: id

config_deleteObjects

config_deleteObjects(configs)

  • Parameter: configs

config_getHashes

config_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

config_getIdents

config_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

config_getObjects

config_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

config_insertObject

config_insertObject(config)

  • Parameter: config

config_updateObject

config_updateObject(config)

  • Parameter: config

config_updateObjects

config_updateObjects(configs)

  • Parameter: configs

configState_create

configState_create(configId, objectId, values=null)

  • Parameter: configId

  • Parameter: objectId

  • Parameter: values

    • Default: null

configState_createObjects

configState_createObjects(configStates)

  • Parameter: configStates

configState_delete

configState_delete(configId, objectId)

  • Parameter: configId

  • Parameter: objectId

configState_deleteObjects

configState_deleteObjects(configStates)

  • Parameter: configStates

configState_getClientToDepotserver

configState_getClientToDepotserver(depotIds=[], clientIds=[], masterOnly=True, productIds=[])

Get a mapping of client and depots.

  • Parameter: depotIds

    • Type: [str, ]

    • Default: []

    • Description: Limit the search to the specified depot ids. If nothing is given all depots are taken into account.

  • Parameter: clientIds

    • Type: [str, ]

    • Default: []

    • Description: Limit the search to the specified client ids. If nothing is given all depots are taken into account.

  • Parameter: masterOnly

    • Type: bool

    • Default: True

    • Description: If this is set to True only master depots are taken into account.

  • Parameter: productIds

    • Type: [str,]

    • Default: []

    • Description: Limit the data to the specified products if alternative depots are to be taken into account.

Returns [{"depotId": str, "alternativeDepotIds": [str, ], "clientId": str},] : A list of dicts containing the keys depotId and clientId that belong to each other. If alternative depots are taken into the IDs of these depots are to be found in the list behind alternativeDepotIds. The key does always exist but may be empty.

configState_getHashes

configState_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

configState_getIdents

configState_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

configState_getObjects

configState_getObjects(attributes=[], filter)

Add default objects to result for objects which do not exist in backend

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

configState_insertObject

configState_insertObject(configState)

  • Parameter: configState

configState_updateObject

configState_updateObject(configState)

  • Parameter: configState

configState_updateObjects

configState_updateObjects(configStates)

  • Parameter: configStates

createClient

createClient(clientName, domain, description=null, notes=null, ipAddress=null, hardwareAddress=null)

  • Parameter: clientName

  • Parameter: domain

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: ipAddress

    • Default: null

  • Parameter: hardwareAddress

    • Default: null

createDepot

createDepot(depotName, domain, depotLocalUrl, depotRemoteUrl, repositoryLocalUrl, repositoryRemoteUrl, network, description=null, notes=null, maxBandwidth=0)

  • Parameter: depotName

  • Parameter: domain

  • Parameter: depotLocalUrl

  • Parameter: depotRemoteUrl

  • Parameter: repositoryLocalUrl

  • Parameter: repositoryRemoteUrl

  • Parameter: network

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: maxBandwidth

    • Default: 0

createGroup

createGroup(groupId, members=[], description="", parentGroupId="")

  • Parameter: groupId

  • Parameter: members

    • Default: []

  • Parameter: description

    • Default: ""

  • Parameter: parentGroupId

    • Default: ""

createLicenseContract

createLicenseContract(licenseContractId="", partner="",conclusionDate="", notificationDate="",expirationDate="", notes="")

  • Parameter: licenseContractId

    • Default: ""

  • Parameter: partner

    • Default: ""

  • Parameter: conclusionDate

    • Default: ""

  • Parameter: notificationDate

    • Default: ""

  • Parameter: expirationDate

    • Default: ""

  • Parameter: notes

    • Default: ""

createLicensePool

createLicensePool(licensePoolId="", description="", productIds=[], windowsSoftwareIds=[])

  • Parameter: licensePoolId

    • Default: ""

  • Parameter: description

    • Default: ""

  • Parameter: productIds

    • Default: []

  • Parameter: windowsSoftwareIds

    • Default: []

createLocalBootProduct

createLocalBootProduct(productId, name, productVersion, packageVersion, licenseRequired=0,setupScript="", uninstallScript="", updateScript="", alwaysScript="", onceScript="",priority=0, description="", advice="", productClassNames=("localBoot"),windowsSoftwareIds=[], depotIds=[])

  • Parameter: productId

  • Parameter: name

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: licenseRequired

    • Default: 0

  • Parameter: setupScript

    • Default: ""

  • Parameter: uninstallScript

    • Default: ""

  • Parameter: updateScript

    • Default: ""

  • Parameter: alwaysScript

    • Default: ""

  • Parameter: onceScript

    • Default: ""

  • Parameter: priority

    • Default: 0

  • Parameter: description

    • Default: ""

  • Parameter: advice

    • Default: ""

  • Parameter: productClassNames

    • Default: ("localBoot")

  • Parameter: windowsSoftwareIds

    • Default: []

  • Parameter: depotIds

    • Default: []

createNetBootProduct

createNetBootProduct(productId, name, productVersion, packageVersion, licenseRequired=0,setupScript="", uninstallScript="", updateScript="", alwaysScript="", onceScript="",priority=0, description="", advice="", productClassNames=("netboot"), pxeConfigTemplate="",windowsSoftwareIds=[], depotIds=[])

  • Parameter: productId

  • Parameter: name

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: licenseRequired

    • Default: 0

  • Parameter: setupScript

    • Default: ""

  • Parameter: uninstallScript

    • Default: ""

  • Parameter: updateScript

    • Default: ""

  • Parameter: alwaysScript

    • Default: ""

  • Parameter: onceScript

    • Default: ""

  • Parameter: priority

    • Default: 0

  • Parameter: description

    • Default: ""

  • Parameter: advice

    • Default: ""

  • Parameter: productClassNames

    • Default: ("netboot")

  • Parameter: pxeConfigTemplate

    • Default: ""

  • Parameter: windowsSoftwareIds

    • Default: []

  • Parameter: depotIds

    • Default: []

createOpsiBase

createOpsiBase()

createProduct

createProduct(productType, productId, name, productVersion, packageVersion, licenseRequired=0,setupScript="", uninstallScript="", updateScript="", alwaysScript="", onceScript="",priority=0, description="", advice="", productClassNames=(), pxeConfigTemplate="",windowsSoftwareIds=[], depotIds=[])

  • Parameter: productType

  • Parameter: productId

  • Parameter: name

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: licenseRequired

    • Default: 0

  • Parameter: setupScript

    • Default: ""

  • Parameter: uninstallScript

    • Default: ""

  • Parameter: updateScript

    • Default: ""

  • Parameter: alwaysScript

    • Default: ""

  • Parameter: onceScript

    • Default: ""

  • Parameter: priority

    • Default: 0

  • Parameter: description

    • Default: ""

  • Parameter: advice

    • Default: ""

  • Parameter: productClassNames

    • Default: ()

  • Parameter: pxeConfigTemplate

    • Default: ""

  • Parameter: windowsSoftwareIds

    • Default: []

  • Parameter: depotIds

    • Default: []

createProductDependency

createProductDependency(productId, action, requiredProductId="", requiredProductClassId="", requiredAction="", requiredInstallationStatus="", requirementType="", depotIds=[])

  • Parameter: productId

  • Parameter: action

  • Parameter: requiredProductId

    • Default: ""

  • Parameter: requiredProductClassId

    • Default: ""

  • Parameter: requiredAction

    • Default: ""

  • Parameter: requiredInstallationStatus

    • Default: ""

  • Parameter: requirementType

    • Default: ""

  • Parameter: depotIds

    • Default: []

createProductPropertyDefinition

createProductPropertyDefinition(productId, name, description=null, defaultValue=null, possibleValues=[], depotIds=[])

  • Parameter: productId

  • Parameter: name

  • Parameter: description

    • Default: null

  • Parameter: defaultValue

    • Default: null

  • Parameter: possibleValues

    • Default: []

  • Parameter: depotIds

    • Default: []

createServer

createServer(serverName, domain, description=null, notes=null)

  • Parameter: serverName

  • Parameter: domain

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

createSoftwareLicense

createSoftwareLicense(softwareLicenseId="", licenseContractId="", licenseType="", maxInstallations="", boundToHost="", expirationDate="")

  • Parameter: softwareLicenseId

    • Default: ""

  • Parameter: licenseContractId

    • Default: ""

  • Parameter: licenseType

    • Default: ""

  • Parameter: maxInstallations

    • Default: ""

  • Parameter: boundToHost

    • Default: ""

  • Parameter: expirationDate

    • Default: ""

deleteAllSoftwareLicenseUsages

deleteAllSoftwareLicenseUsages(hostIds)

  • Parameter: hostIds

deleteClient

deleteClient(clientId)

  • Parameter: clientId

deleteDepot

deleteDepot(depotId)

  • Parameter: depotId

deleteGeneralConfig

deleteGeneralConfig(objectId)

  • Parameter: objectId

deleteGroup

deleteGroup(groupId)

  • Parameter: groupId

deleteHardwareInformation

deleteHardwareInformation(hostId)

  • Parameter: hostId

deleteLicenseContract

deleteLicenseContract(licenseContractId)

  • Parameter: licenseContractId

deleteLicensePool

deleteLicensePool(licensePoolId, deleteLicenses=False)

  • Parameter: licensePoolId

  • Parameter: deleteLicenses

    • Default: False

deleteProductDependency

deleteProductDependency(productId, action="", requiredProductId="", requiredProductClassId="", requirementType="", depotIds=[])

  • Parameter: productId

  • Parameter: action

    • Default: ""

  • Parameter: requiredProductId

    • Default: ""

  • Parameter: requiredProductClassId

    • Default: ""

  • Parameter: requirementType

    • Default: ""

  • Parameter: depotIds

    • Default: []

deleteProductPropertyDefinition

deleteProductPropertyDefinition(productId, name, depotIds=[])

  • Parameter: productId

  • Parameter: name

  • Parameter: depotIds

    • Default: []

deleteProductPropertyDefinitions

deleteProductPropertyDefinitions(productId, depotIds=[])

  • Parameter: productId

  • Parameter: depotIds

    • Default: []

deleteServer

deleteServer(serverId)

  • Parameter: serverId

deleteSoftwareInformation

deleteSoftwareInformation(hostId)

  • Parameter: hostId

deleteSoftwareLicense

deleteSoftwareLicense(softwareLicenseId, removeFromPools=False)

  • Parameter: softwareLicenseId

  • Parameter: removeFromPools

    • Default: False

deleteSoftwareLicenseUsage

deleteSoftwareLicenseUsage(hostId, softwareLicenseId="", licensePoolId="", productId="", windowsSoftwareId="")

  • Parameter: hostId

  • Parameter: softwareLicenseId

    • Default: ""

  • Parameter: licensePoolId

    • Default: ""

  • Parameter: productId

    • Default: ""

  • Parameter: windowsSoftwareId

    • Default: ""

depot_createMd5SumFile

depot_createMd5SumFile(filename, md5sumFilename)

  • Parameter: filename

  • Parameter: md5sumFilename

depot_createZsyncFile

depot_createZsyncFile(filename, zsyncFilename)

  • Parameter: filename

  • Parameter: zsyncFilename

depot_getDiskSpaceUsage

depot_getDiskSpaceUsage(path)

  • Parameter: path

depot_getHostRSAPublicKey

depot_getHostRSAPublicKey()

depot_getMD5Sum

depot_getMD5Sum(filename, forceCalculation=False)

  • Parameter: filename

  • Parameter: forceCalculation

    • Default: False

depot_installPackage

depot_installPackage(filename, force=False, propertyDefaultValues={}, tempDir=null, forceProductId=null, suppressPackageContentFileGeneration=False)

  • Parameter: filename

  • Parameter: force

    • Default: False

  • Parameter: propertyDefaultValues

    • Default: {}

  • Parameter: tempDir

    • Default: null

  • Parameter: forceProductId

    • Default: null

  • Parameter: suppressPackageContentFileGeneration

    • Default: False

depot_librsyncDeltaFile

depot_librsyncDeltaFile(filename, signature, deltafile)

  • Parameter: filename

  • Parameter: signature

  • Parameter: deltafile

depot_librsyncPatchFile

depot_librsyncPatchFile(oldfile, deltafile, newfile)

  • Parameter: oldfile

  • Parameter: deltafile

  • Parameter: newfile

depot_librsyncSignature

depot_librsyncSignature(filename)

  • Parameter: filename

depot_uninstallPackage

depot_uninstallPackage(productId, force=False, deleteFiles=True)

  • Parameter: productId

  • Parameter: force

    • Default: False

  • Parameter: deleteFiles

    • Default: True

dhcpd_deleteHost

dhcpd_deleteHost(host)

  • Parameter: host

dhcpd_updateHost

dhcpd_updateHost(host)

  • Parameter: host

disableAutoCommit

disableAutoCommit(sqlInstance)

Disable automatic committing.

  • Parameter: sqlInstance

    • Type: MySQL

dispatcher_getBackendNames

dispatcher_getBackendNames()

dispatcher_getConfig

dispatcher_getConfig()

exit

exit()

getAndAssignSoftwareLicenseKey

getAndAssignSoftwareLicenseKey(hostId, licensePoolId="", productId="", windowsSoftwareId="")

  • Parameter: hostId

  • Parameter: licensePoolId

    • Default: ""

  • Parameter: productId

    • Default: ""

  • Parameter: windowsSoftwareId

    • Default: ""

getBackendInfos_listOfHashes

getBackendInfos_listOfHashes()

getClientCacheFilePath

getClientCacheFilePath(clientId)

  • Parameter: clientId

getClientIdByMac

getClientIdByMac(mac)

  • Parameter: mac

getClientIds_list

getClientIds_list(serverId=null, depotIds=[], groupId=null, productId=null, installationStatus=null, actionRequest=null, productVersion=null, packageVersion=null, hwFilter=null)

  • Parameter: serverId

    • Default: null

  • Parameter: depotIds

    • Default: []

  • Parameter: groupId

    • Default: null

  • Parameter: productId

    • Default: null

  • Parameter: installationStatus

    • Default: null

  • Parameter: actionRequest

    • Default: null

  • Parameter: productVersion

    • Default: null

  • Parameter: packageVersion

    • Default: null

  • Parameter: hwFilter

    • Default: null

getClients_listOfHashes

getClients_listOfHashes(serverId=null, depotIds=[], groupId=null, productId=null, installationStatus=null, actionRequest=null, productVersion=null, packageVersion=null, hwFilter=null)

  • Parameter: serverId

    • Default: null

  • Parameter: depotIds

    • Default: []

  • Parameter: groupId

    • Default: null

  • Parameter: productId

    • Default: null

  • Parameter: installationStatus

    • Default: null

  • Parameter: actionRequest

    • Default: null

  • Parameter: productVersion

    • Default: null

  • Parameter: packageVersion

    • Default: null

  • Parameter: hwFilter

    • Default: null

getClientsWithOutdatedProduct

getClientsWithOutdatedProduct(productId)

Get clients where the product with id productId is outdated. This does only take clients into account where the 'installationStatus' is set and is neither 'not_installed', 'unknown' nor 'none'.

  • Parameter: productId

Returns set : The IDs of clients with an outdated version installed.

getData

getData(query)

  • Parameter: query

getDepot_hash

getDepot_hash(depotId)

  • Parameter: depotId

getDepotId

getDepotId(clientId=null)

  • Parameter: clientId

    • Default: null

getDepotIds_list

getDepotIds_list()

getDepotSelectionAlgorithm

getDepotSelectionAlgorithm()

Returns the selected depot selection algorythm. "

getDepotSelectionAlgorithmByLatency

getDepotSelectionAlgorithmByLatency()

getDepotSelectionAlgorithmByMasterDepotAndLatency

getDepotSelectionAlgorithmByMasterDepotAndLatency()

getDepotSelectionAlgorithmByNetworkAddress

getDepotSelectionAlgorithmByNetworkAddress()

getDepotWithLowestLatency

getDepotWithLowestLatency(latency)

Given a dict with depot as key and latency as value it will return the depot with the lowest latency. Will return None if no depot can be determined.

  • Parameter: latency

getDiskSpaceUsage

getDiskSpaceUsage(path)

  • Parameter: path

getDomain

getDomain()

getGeneralConfig_hash

getGeneralConfig_hash(objectId=null)

  • Parameter: objectId

    • Default: null

getGeneralConfigValue

getGeneralConfigValue(key, objectId=null)

  • Parameter: key

  • Parameter: objectId

    • Default: null

getGroupIds_list

getGroupIds_list()

getHardwareAuditDataCount

getHardwareAuditDataCount()

Get the count of data relevant to the hardware audit.

getHardwareInformation_hash

getHardwareInformation_hash(hostId)

  • Parameter: hostId

getHost_hash

getHost_hash(hostId)

  • Parameter: hostId

getHostGroupTree_hash

getHostGroupTree_hash()

getHostId

getHostId(hostname)

  • Parameter: hostname

getHostRSAPublicKey

getHostRSAPublicKey()

getInstallableLocalBootProductIds_list

getInstallableLocalBootProductIds_list(clientId)

  • Parameter: clientId

getInstallableNetBootProductIds_list

getInstallableNetBootProductIds_list(clientId)

  • Parameter: clientId

getInstallableProductIds_list

getInstallableProductIds_list(clientId)

  • Parameter: clientId

getInstalledLocalBootProductIds_list

getInstalledLocalBootProductIds_list(objectId)

  • Parameter: objectId

getInstalledNetBootProductIds_list

getInstalledNetBootProductIds_list(objectId)

  • Parameter: objectId

getInstalledProductIds_list

getInstalledProductIds_list(objectId)

  • Parameter: objectId

getIpAddress

getIpAddress(hostId)

  • Parameter: hostId

getKioskProductInfosForClient

getKioskProductInfosForClient(clientId)

Collect the data as required by the opsi kiosk client.

  • Parameter: clientId

    • Type: str

    • Description: ID of the client for whom the data gets collected.

Returns list of dicts

Raises BackendMissingDataError: If no client with clientId exists., RuntimeError: In case something goes wrong.

getLatencyInformation

getLatencyInformation(depots)

Pings the given depots and returns the latency information in a dict with depot as key and the latency as value. Depots that can’t be reached in time will not be included.

  • Parameter: depots

getLicenseContract_hash

getLicenseContract_hash(licenseContractId)

  • Parameter: licenseContractId

getLicenseContractIds_list

getLicenseContractIds_list()

getLicenseContracts_listOfHashes

getLicenseContracts_listOfHashes()

getLicenseKey

getLicenseKey(productId, clientId)

Returns an unused licensekey if available or the license key assigend to a specific client ! do not use ! deprecated !

  • Parameter: productId

  • Parameter: clientId

getLicensePool_hash

getLicensePool_hash(licensePoolId)

  • Parameter: licensePoolId

getLicensePoolId

getLicensePoolId(productId="", windowsSoftwareId="")

  • Parameter: productId

    • Default: ""

  • Parameter: windowsSoftwareId

    • Default: ""

getLicensePoolIds_list

getLicensePoolIds_list()

getLicensePools_listOfHashes

getLicensePools_listOfHashes()

getLicenseStatistics_hash

getLicenseStatistics_hash()

getLocalBootProductIds_list

getLocalBootProductIds_list(objectId=null, installationStatus=null)

  • Parameter: objectId

    • Default: null

  • Parameter: installationStatus

    • Default: null

getLocalBootProductStates_hash

getLocalBootProductStates_hash(objectIds=[], options={})

  • Parameter: objectIds

    • Default: []

  • Parameter: options

    • Default: {}

getMacAddress

getMacAddress(hostId)

  • Parameter: hostId

getMacAddresses_list

getMacAddresses_list(hostId)

  • Parameter: hostId

getMD5Sum

getMD5Sum(filename)

  • Parameter: filename

getNetBootProductIds_list

getNetBootProductIds_list(objectId=null, installationStatus=null)

  • Parameter: objectId

    • Default: null

  • Parameter: installationStatus

    • Default: null

getNetBootProductStates_hash

getNetBootProductStates_hash(objectIds=[], options={})

  • Parameter: objectIds

    • Default: []

  • Parameter: options

    • Default: {}

getNetworkConfig_hash

getNetworkConfig_hash(objectId=null)

  • Parameter: objectId

    • Default: null

getNetworkConfigValue

getNetworkConfigValue(key, objectId=null)

  • Parameter: key

  • Parameter: objectId

    • Default: null

getOpsiHostKey

getOpsiHostKey(hostId)

  • Parameter: hostId

getOpsiHWAuditConf

getOpsiHWAuditConf(locale=null)

  • Parameter: locale

    • Default: null

getOpsiInformation_hash

getOpsiInformation_hash()

getOrCreateSoftwareLicenseUsage_hash

getOrCreateSoftwareLicenseUsage_hash(hostId, licensePoolId="", productId="", windowsSoftwareId="")

  • Parameter: hostId

  • Parameter: licensePoolId

    • Default: ""

  • Parameter: productId

    • Default: ""

  • Parameter: windowsSoftwareId

    • Default: ""

getPcpatchPassword

getPcpatchPassword(hostId)

  • Parameter: hostId

getPossibleImagefileValuesForHostGroup

getPossibleImagefileValuesForHostGroup(groupId)

  • Parameter: groupId

getPossibleMethods_listOfHashes

getPossibleMethods_listOfHashes()

getPossibleProductActions_hash

getPossibleProductActions_hash(depotId=null)

  • Parameter: depotId

    • Default: null

getPossibleProductActions_list

getPossibleProductActions_list(productId=null, depotId=null)

  • Parameter: productId

    • Default: null

  • Parameter: depotId

    • Default: null

getProduct_hash

getProduct_hash(productId, depotId=null)

  • Parameter: productId

  • Parameter: depotId

    • Default: null

getProductActionRequests_listOfHashes

getProductActionRequests_listOfHashes(clientId, options=null)

  • Parameter: clientId

  • Parameter: options

    • Default: null

getProductDependencies_listOfHashes

getProductDependencies_listOfHashes(productId=null, depotId=null)

  • Parameter: productId

    • Default: null

  • Parameter: depotId

    • Default: null

getProductIds_list

getProductIds_list(productType=null, objectId=null, installationStatus=null)

  • Parameter: productType

    • Default: null

  • Parameter: objectId

    • Default: null

  • Parameter: installationStatus

    • Default: null

getProductInstallationStatus_hash

getProductInstallationStatus_hash(productId, objectId)

  • Parameter: productId

  • Parameter: objectId

getProductInstallationStatus_listOfHashes

getProductInstallationStatus_listOfHashes(objectId)

  • Parameter: objectId

getProductLocks_hash

getProductLocks_hash(depotIds=[])

  • Parameter: depotIds

    • Default: []

getProductOrdering

getProductOrdering(depotId, sortAlgorithm=null)

  • Parameter: depotId

  • Parameter: sortAlgorithm

    • Default: null

getProductProperties_hash

getProductProperties_hash(productId, objectId=null)

  • Parameter: productId

  • Parameter: objectId

    • Default: null

getProductPropertyDefinitions_hash

getProductPropertyDefinitions_hash(depotId=null)

  • Parameter: depotId

    • Default: null

getProductPropertyDefinitions_listOfHashes

getProductPropertyDefinitions_listOfHashes(productId, depotId=null)

  • Parameter: productId

  • Parameter: depotId

    • Default: null

getProducts_hash

getProducts_hash(depotIds=[])

  • Parameter: depotIds

    • Default: []

getProducts_listOfHashes

getProducts_listOfHashes(depotId=null)

  • Parameter: depotId

    • Default: null

getProductStates_hash

getProductStates_hash(objectIds=[], options={})

  • Parameter: objectIds

    • Default: []

  • Parameter: options

    • Default: {}

getProvidedLocalBootProductIds_list

getProvidedLocalBootProductIds_list(depotId)

  • Parameter: depotId

getProvidedNetBootProductIds_list

getProvidedNetBootProductIds_list(depotId)

  • Parameter: depotId

getRawData

getRawData(query)

  • Parameter: query

getServerId

getServerId(clientId)

  • Parameter: clientId

getServerIds_list

getServerIds_list()

getServiceTime

getServiceTime(utctime=False)

  • Parameter: utctime

    • Default: False

getSoftwareAuditDataCount

getSoftwareAuditDataCount()

Get the count of data relevant to the software audit.

getSoftwareInformation_hash

getSoftwareInformation_hash(hostId)

  • Parameter: hostId

getSoftwareInformation_listOfHashes

getSoftwareInformation_listOfHashes()

getSoftwareLicense_hash

getSoftwareLicense_hash(softwareLicenseId)

  • Parameter: softwareLicenseId

getSoftwareLicenseIds_list

getSoftwareLicenseIds_list()

getSoftwareLicenses_listOfHashes

getSoftwareLicenses_listOfHashes()

getSoftwareLicenseUsages_listOfHashes

getSoftwareLicenseUsages_listOfHashes(hostIds=[], licensePoolIds=[])

  • Parameter: hostIds

    • Default: []

  • Parameter: licensePoolIds

    • Default: []

group_createHostGroup

group_createHostGroup(id, description=null, notes=null, parentGroupId=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: parentGroupId

    • Default: null

group_createObjects

group_createObjects(groups)

  • Parameter: groups

group_createProductGroup

group_createProductGroup(id, description=null, notes=null, parentGroupId=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: parentGroupId

    • Default: null

group_delete

group_delete(id)

  • Parameter: id

group_deleteObjects

group_deleteObjects(groups)

  • Parameter: groups

group_getHashes

group_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

group_getIdents

group_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

group_getObjects

group_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

group_insertObject

group_insertObject(group)

  • Parameter: group

group_rename

group_rename(oldGroupId, newGroupId)

  • Parameter: oldGroupId

  • Parameter: newGroupId

group_updateObject

group_updateObject(group)

  • Parameter: group

group_updateObjects

group_updateObjects(groups)

  • Parameter: groups

groupname_exists

groupname_exists(groupId)

  • Parameter: groupId

host_createObjects

host_createObjects(hosts)

  • Parameter: hosts

host_createOpsiClient

host_createOpsiClient(id, opsiHostKey=null, description=null, notes=null, hardwareAddress=null, ipAddress=null, inventoryNumber=null, oneTimePassword=null, created=null, lastSeen=null)

  • Parameter: id

  • Parameter: opsiHostKey

    • Default: null

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: hardwareAddress

    • Default: null

  • Parameter: ipAddress

    • Default: null

  • Parameter: inventoryNumber

    • Default: null

  • Parameter: oneTimePassword

    • Default: null

  • Parameter: created

    • Default: null

  • Parameter: lastSeen

    • Default: null

host_createOpsiConfigserver

host_createOpsiConfigserver(id,opsiHostKey=null, depotLocalUrl=null, depotRemoteUrl=null,depotWebdavUrl=null, repositoryLocalUrl=null,repositoryRemoteUrl=null, description=null, notes=null,hardwareAddress=null, ipAddress=null, inventoryNumber=null,networkAddress=null, maxBandwidth=null, isMasterDepot=null,masterDepotId=null, workbenchLocalUrl=null, workbenchRemoteUrl=null)

  • Parameter: id

  • Parameter: opsiHostKey

    • Default: null

  • Parameter: depotLocalUrl

    • Default: null

  • Parameter: depotRemoteUrl

    • Default: null

  • Parameter: depotWebdavUrl

    • Default: null

  • Parameter: repositoryLocalUrl

    • Default: null

  • Parameter: repositoryRemoteUrl

    • Default: null

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: hardwareAddress

    • Default: null

  • Parameter: ipAddress

    • Default: null

  • Parameter: inventoryNumber

    • Default: null

  • Parameter: networkAddress

    • Default: null

  • Parameter: maxBandwidth

    • Default: null

  • Parameter: isMasterDepot

    • Default: null

  • Parameter: masterDepotId

    • Default: null

  • Parameter: workbenchLocalUrl

    • Default: null

  • Parameter: workbenchRemoteUrl

    • Default: null

host_createOpsiDepotserver

host_createOpsiDepotserver(id,opsiHostKey=null, depotLocalUrl=null, depotRemoteUrl=null,depotWebdavUrl=null, repositoryLocalUrl=null,repositoryRemoteUrl=null, description=null, notes=null,hardwareAddress=null, ipAddress=null, inventoryNumber=null,networkAddress=null, maxBandwidth=null, isMasterDepot=null,masterDepotId=null, workbenchLocalUrl=null, workbenchRemoteUrl=null)

  • Parameter: id

  • Parameter: opsiHostKey

    • Default: null

  • Parameter: depotLocalUrl

    • Default: null

  • Parameter: depotRemoteUrl

    • Default: null

  • Parameter: depotWebdavUrl

    • Default: null

  • Parameter: repositoryLocalUrl

    • Default: null

  • Parameter: repositoryRemoteUrl

    • Default: null

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: hardwareAddress

    • Default: null

  • Parameter: ipAddress

    • Default: null

  • Parameter: inventoryNumber

    • Default: null

  • Parameter: networkAddress

    • Default: null

  • Parameter: maxBandwidth

    • Default: null

  • Parameter: isMasterDepot

    • Default: null

  • Parameter: masterDepotId

    • Default: null

  • Parameter: workbenchLocalUrl

    • Default: null

  • Parameter: workbenchRemoteUrl

    • Default: null

host_delete

host_delete(id)

  • Parameter: id

host_deleteObjects

host_deleteObjects(hosts)

  • Parameter: hosts

host_getHashes

host_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

host_getIdents

host_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

host_getObjects

host_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

host_insertObject

host_insertObject(host)

  • Parameter: host

host_renameOpsiClient

host_renameOpsiClient(id, newId)

  • Parameter: id

  • Parameter: newId

host_renameOpsiDepotserver

host_renameOpsiDepotserver(oldId, newId)

Rename OpsiDepotserver with id oldId to newId. References to the old id will be changed aswell.

  • Parameter: oldId

    • Type: str

    • Description: ID of the server to change., New ID.

  • Parameter: newId

    • Type: str

Raises BackendMissingDataError: If no depot oldId is found., BackendError: If depot newId already exists.

host_updateObject

host_updateObject(host)

  • Parameter: host

host_updateObjects

host_updateObjects(hosts)

  • Parameter: hosts

hostControl_execute

hostControl_execute(command, hostIds=[], waitForEnding=True, captureStderr=True, encoding=null, timeout=300)

  • Parameter: command

  • Parameter: hostIds

    • Default: []

  • Parameter: waitForEnding

    • Default: True

  • Parameter: captureStderr

    • Default: True

  • Parameter: encoding

    • Default: null

  • Parameter: timeout

    • Default: 300

hostControl_fireEvent

hostControl_fireEvent(event, hostIds=[])

  • Parameter: event

  • Parameter: hostIds

    • Default: []

hostControl_getActiveSessions

hostControl_getActiveSessions(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControl_opsiclientdRpc

hostControl_opsiclientdRpc(method, params=[], hostIds=[], timeout=null)

  • Parameter: method

  • Parameter: params

    • Default: []

  • Parameter: hostIds

    • Default: []

  • Parameter: timeout

    • Default: null

hostControl_reachable

hostControl_reachable(hostIds=[], timeout=null)

  • Parameter: hostIds

    • Default: []

  • Parameter: timeout

    • Default: null

hostControl_reboot

hostControl_reboot(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControl_showPopup

hostControl_showPopup(message, hostIds=[])

  • Parameter: message

  • Parameter: hostIds

    • Default: []

hostControl_shutdown

hostControl_shutdown(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControl_start

hostControl_start(hostIds=[])

Switches on remote computers using WOL. '

  • Parameter: hostIds

    • Default: []

hostControl_uptime

hostControl_uptime(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControlSafe_execute

hostControlSafe_execute(command, hostIds=[], waitForEnding=True, captureStderr=True, encoding=null, timeout=300)

  • Parameter: command

  • Parameter: hostIds

    • Default: []

  • Parameter: waitForEnding

    • Default: True

  • Parameter: captureStderr

    • Default: True

  • Parameter: encoding

    • Default: null

  • Parameter: timeout

    • Default: 300

hostControlSafe_fireEvent

hostControlSafe_fireEvent(event, hostIds=[])

  • Parameter: event

  • Parameter: hostIds

    • Default: []

hostControlSafe_getActiveSessions

hostControlSafe_getActiveSessions(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControlSafe_opsiclientdRpc

hostControlSafe_opsiclientdRpc(method, params=[], hostIds=[], timeout=null)

  • Parameter: method

  • Parameter: params

    • Default: []

  • Parameter: hostIds

    • Default: []

  • Parameter: timeout

    • Default: null

hostControlSafe_reachable

hostControlSafe_reachable(hostIds=[], timeout=null)

  • Parameter: hostIds

    • Default: []

  • Parameter: timeout

    • Default: null

hostControlSafe_reboot

hostControlSafe_reboot(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControlSafe_showPopup

hostControlSafe_showPopup(message, hostIds=[])

  • Parameter: message

  • Parameter: hostIds

    • Default: []

hostControlSafe_shutdown

hostControlSafe_shutdown(hostIds=[])

  • Parameter: hostIds

    • Default: []

hostControlSafe_start

hostControlSafe_start(hostIds=[])

Switches on remote computers using WOL. '

  • Parameter: hostIds

    • Default: []

hostControlSafe_uptime

hostControlSafe_uptime(hostIds=[])

  • Parameter: hostIds

    • Default: []

librsyncSignature

librsyncSignature(filename)

  • Parameter: filename

licenseContract_create

licenseContract_create(id, description=null, notes=null, partner=null, conclusionDate=null, notificationDate=null, expirationDate=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: notes

    • Default: null

  • Parameter: partner

    • Default: null

  • Parameter: conclusionDate

    • Default: null

  • Parameter: notificationDate

    • Default: null

  • Parameter: expirationDate

    • Default: null

licenseContract_createObjects

licenseContract_createObjects(licenseContracts)

  • Parameter: licenseContracts

licenseContract_delete

licenseContract_delete(id)

  • Parameter: id

licenseContract_deleteObjects

licenseContract_deleteObjects(licenseContracts)

  • Parameter: licenseContracts

licenseContract_getHashes

licenseContract_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licenseContract_getIdents

licenseContract_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

licenseContract_getObjects

licenseContract_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licenseContract_insertObject

licenseContract_insertObject(licenseContract)

  • Parameter: licenseContract

licenseContract_updateObject

licenseContract_updateObject(licenseContract)

  • Parameter: licenseContract

licenseContract_updateObjects

licenseContract_updateObjects(licenseContracts)

  • Parameter: licenseContracts

licenseOnClient_create

licenseOnClient_create(softwareLicenseId, licensePoolId, clientId, licenseKey=null, notes=null)

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

  • Parameter: clientId

  • Parameter: licenseKey

    • Default: null

  • Parameter: notes

    • Default: null

licenseOnClient_createObjects

licenseOnClient_createObjects(licenseOnClients)

  • Parameter: licenseOnClients

licenseOnClient_delete

licenseOnClient_delete(softwareLicenseId, licensePoolId, clientId)

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

  • Parameter: clientId

licenseOnClient_deleteObjects

licenseOnClient_deleteObjects(licenseOnClients)

  • Parameter: licenseOnClients

licenseOnClient_getHashes

licenseOnClient_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licenseOnClient_getIdents

licenseOnClient_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

licenseOnClient_getObjects

licenseOnClient_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licenseOnClient_getOrCreateObject

licenseOnClient_getOrCreateObject(clientId, licensePoolId=null, productId=null, windowsSoftwareId=null)

  • Parameter: clientId

  • Parameter: licensePoolId

    • Default: null

  • Parameter: productId

    • Default: null

  • Parameter: windowsSoftwareId

    • Default: null

licenseOnClient_insertObject

licenseOnClient_insertObject(licenseOnClient)

  • Parameter: licenseOnClient

licenseOnClient_updateObject

licenseOnClient_updateObject(licenseOnClient)

  • Parameter: licenseOnClient

licenseOnClient_updateObjects

licenseOnClient_updateObjects(licenseOnClients)

  • Parameter: licenseOnClients

licensePool_create

licensePool_create(id, description=null, productIds=null)

  • Parameter: id

  • Parameter: description

    • Default: null

  • Parameter: productIds

    • Default: null

licensePool_createObjects

licensePool_createObjects(licensePools)

  • Parameter: licensePools

licensePool_delete

licensePool_delete(id)

  • Parameter: id

licensePool_deleteObjects

licensePool_deleteObjects(licensePools)

  • Parameter: licensePools

licensePool_getHashes

licensePool_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licensePool_getIdents

licensePool_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

licensePool_getObjects

licensePool_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

licensePool_insertObject

licensePool_insertObject(licensePool)

  • Parameter: licensePool

licensePool_updateObject

licensePool_updateObject(licensePool)

  • Parameter: licensePool

licensePool_updateObjects

licensePool_updateObjects(licensePools)

  • Parameter: licensePools

lockProduct

lockProduct(productId, depotIds=[])

  • Parameter: productId

  • Parameter: depotIds

    • Default: []

log_read

log_read(logType, objectId=null, maxSize=DEFAULT_MAX_LOGFILE_SIZE)

Return the content of a log.

  • Parameter: logType

    • Description: Type of log. Currently supported: bootimage, clientconnect, instlog, opsiconfd or userlogin.

  • Parameter: objectId

    • Default: null

    • Description: Specialising of logType

  • Parameter: maxSize

    • Default: DEFAULT_MAX_LOGFILE_SIZE

    • Description: Limit for the size of returned characters in bytes. Setting this to 0 disables limiting.

log_write

log_write(logType, data, objectId=null, append=False)

Write log data into the corresponding log file.

  • Parameter: logType

    • Description: Type of log. Currently supported: bootimage, clientconnect, instlog, opsiconfd or userlogin.

  • Parameter: data

    • Type: Unicode

    • Description: Log content

  • Parameter: objectId

    • Default: null

    • Description: Specialising of logType

  • Parameter: append

    • Type: bool

    • Default: False

    • Description: Changes the behaviour to either append or overwrite the log.

objectToGroup_create

objectToGroup_create(groupType, groupId, objectId)

  • Parameter: groupType

  • Parameter: groupId

  • Parameter: objectId

objectToGroup_createObjects

objectToGroup_createObjects(objectToGroups)

  • Parameter: objectToGroups

objectToGroup_delete

objectToGroup_delete(groupType, groupId, objectId)

  • Parameter: groupType

  • Parameter: groupId

  • Parameter: objectId

objectToGroup_deleteObjects

objectToGroup_deleteObjects(objectToGroups)

  • Parameter: objectToGroups

objectToGroup_getHashes

objectToGroup_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

objectToGroup_getIdents

objectToGroup_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

objectToGroup_getObjects

objectToGroup_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

objectToGroup_insertObject

objectToGroup_insertObject(objectToGroup)

  • Parameter: objectToGroup

objectToGroup_updateObject

objectToGroup_updateObject(objectToGroup)

  • Parameter: objectToGroup

objectToGroup_updateObjects

objectToGroup_updateObjects(objectToGroups)

  • Parameter: objectToGroups

opsipxeconfd_updatePXEBootConfiguration

opsipxeconfd_updatePXEBootConfiguration(clientId, data=null)

Update the boot configuration of a specific client. This method will relay calls to opsipxeconfd who does the handling.

  • Parameter: clientId

    • Type: str

    • Description: The client whose boot configuration should be updated.

  • Parameter: data

    • Type: dict

    • Default: null

    • Description: Collected data for opsipxeconfd.

powerOnHost

powerOnHost(hostId)

  • Parameter: hostId

product_createLocalboot

product_createLocalboot(id, productVersion, packageVersion, name=null, licenseRequired=null,setupScript=null, uninstallScript=null, updateScript=null, alwaysScript=null, onceScript=null,priority=null, description=null, advice=null, changelog=null, productClassIds=null, windowsSoftwareIds=null)

  • Parameter: id

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: name

    • Default: null

  • Parameter: licenseRequired

    • Default: null

  • Parameter: setupScript

    • Default: null

  • Parameter: uninstallScript

    • Default: null

  • Parameter: updateScript

    • Default: null

  • Parameter: alwaysScript

    • Default: null

  • Parameter: onceScript

    • Default: null

  • Parameter: priority

    • Default: null

  • Parameter: description

    • Default: null

  • Parameter: advice

    • Default: null

  • Parameter: changelog

    • Default: null

  • Parameter: productClassIds

    • Default: null

  • Parameter: windowsSoftwareIds

    • Default: null

product_createNetboot

product_createNetboot(id, productVersion, packageVersion, name=null, licenseRequired=null,setupScript=null, uninstallScript=null, updateScript=null, alwaysScript=null, onceScript=null,priority=null, description=null, advice=null, changelog=null, productClassIds=null, windowsSoftwareIds=null,pxeConfigTemplate=null)

  • Parameter: id

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: name

    • Default: null

  • Parameter: licenseRequired

    • Default: null

  • Parameter: setupScript

    • Default: null

  • Parameter: uninstallScript

    • Default: null

  • Parameter: updateScript

    • Default: null

  • Parameter: alwaysScript

    • Default: null

  • Parameter: onceScript

    • Default: null

  • Parameter: priority

    • Default: null

  • Parameter: description

    • Default: null

  • Parameter: advice

    • Default: null

  • Parameter: changelog

    • Default: null

  • Parameter: productClassIds

    • Default: null

  • Parameter: windowsSoftwareIds

    • Default: null

  • Parameter: pxeConfigTemplate

    • Default: null

product_createObjects

product_createObjects(products)

  • Parameter: products

product_delete

product_delete(productId, productVersion, packageVersion)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

product_deleteObjects

product_deleteObjects(products)

  • Parameter: products

product_getHashes

product_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

product_getIdents

product_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

product_getObjects

product_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

product_insertObject

product_insertObject(product)

  • Parameter: product

product_updateObject

product_updateObject(product)

  • Parameter: product

product_updateObjects

product_updateObjects(products)

  • Parameter: products

productDependency_create

productDependency_create(productId, productVersion, packageVersion, productAction, requiredProductId, requiredProductVersion=null, requiredPackageVersion=null, requiredAction=null, requiredInstallationStatus=null, requirementType=null)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: productAction

  • Parameter: requiredProductId

  • Parameter: requiredProductVersion

    • Default: null

  • Parameter: requiredPackageVersion

    • Default: null

  • Parameter: requiredAction

    • Default: null

  • Parameter: requiredInstallationStatus

    • Default: null

  • Parameter: requirementType

    • Default: null

productDependency_createObjects

productDependency_createObjects(productDependencies)

  • Parameter: productDependencies

productDependency_delete

productDependency_delete(productId, productVersion, packageVersion, productAction, requiredProductId)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: productAction

  • Parameter: requiredProductId

productDependency_deleteObjects

productDependency_deleteObjects(productDependencies)

  • Parameter: productDependencies

productDependency_getHashes

productDependency_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productDependency_getIdents

productDependency_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

productDependency_getObjects

productDependency_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productDependency_insertObject

productDependency_insertObject(productDependency)

  • Parameter: productDependency

productDependency_updateObject

productDependency_updateObject(productDependency)

  • Parameter: productDependency

productDependency_updateObjects

productDependency_updateObjects(productDependencies)

  • Parameter: productDependencies

productOnClient_addDependencies

productOnClient_addDependencies(productOnClients)

  • Parameter: productOnClients

productOnClient_create

productOnClient_create(productId, productType, clientId, installationStatus=null, actionRequest=null, lastAction=null, actionProgress=null, actionResult=null, productVersion=null, packageVersion=null, modificationTime=null)

  • Parameter: productId

  • Parameter: productType

  • Parameter: clientId

  • Parameter: installationStatus

    • Default: null

  • Parameter: actionRequest

    • Default: null

  • Parameter: lastAction

    • Default: null

  • Parameter: actionProgress

    • Default: null

  • Parameter: actionResult

    • Default: null

  • Parameter: productVersion

    • Default: null

  • Parameter: packageVersion

    • Default: null

  • Parameter: modificationTime

    • Default: null

productOnClient_createObjects

productOnClient_createObjects(productOnClients)

  • Parameter: productOnClients

productOnClient_delete

productOnClient_delete(productId, clientId)

  • Parameter: productId

  • Parameter: clientId

productOnClient_deleteObjects

productOnClient_deleteObjects(productOnClients)

  • Parameter: productOnClients

productOnClient_generateSequence

productOnClient_generateSequence(productOnClients)

  • Parameter: productOnClients

productOnClient_getHashes

productOnClient_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productOnClient_getIdents

productOnClient_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

productOnClient_getObjects

productOnClient_getObjects(attributes=[], filter)

possible attributes/filter-keys of ProductOnClient are: productId productType clientId targetState installationStatus actionRequest lastAction actionProgress actionResult productVersion packageVersion modificationTime missing ProductOnClients will be created with the following defaults: installationStatus = u’not_installed' actionRequest = u’none' productVersion = None packageVersion = None modificationTime = None targetState = None lastAction = None actionProgress = None actionResult = None

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productOnClient_insertObject

productOnClient_insertObject(productOnClient)

  • Parameter: productOnClient

productOnClient_updateObject

productOnClient_updateObject(productOnClient)

  • Parameter: productOnClient

productOnClient_updateObjects

productOnClient_updateObjects(productOnClients)

  • Parameter: productOnClients

productOnDepot_create

productOnDepot_create(productId, productType, productVersion, packageVersion, depotId, locked=null)

  • Parameter: productId

  • Parameter: productType

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: depotId

  • Parameter: locked

    • Default: null

productOnDepot_createObjects

productOnDepot_createObjects(productOnDepots)

  • Parameter: productOnDepots

productOnDepot_delete

productOnDepot_delete(productId, depotId, productVersion=null, packageVersion=null)

  • Parameter: productId

  • Parameter: depotId

  • Parameter: productVersion

    • Default: null

  • Parameter: packageVersion

    • Default: null

productOnDepot_deleteObjects

productOnDepot_deleteObjects(productOnDepots)

  • Parameter: productOnDepots

productOnDepot_getHashes

productOnDepot_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productOnDepot_getIdents

productOnDepot_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

productOnDepot_getObjects

productOnDepot_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productOnDepot_insertObject

productOnDepot_insertObject(productOnDepot)

If productOnDepot exits (same productId, same depotId, different version) then update existing productOnDepot instead of creating a new one

  • Parameter: productOnDepot

productOnDepot_updateObject

productOnDepot_updateObject(productOnDepot)

  • Parameter: productOnDepot

productOnDepot_updateObjects

productOnDepot_updateObjects(productOnDepots)

  • Parameter: productOnDepots

productProperty_create

productProperty_create(productId, productVersion, packageVersion, propertyId, description=null, possibleValues=null, defaultValues=null, editable=null, multiValue=null)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: propertyId

  • Parameter: description

    • Default: null

  • Parameter: possibleValues

    • Default: null

  • Parameter: defaultValues

    • Default: null

  • Parameter: editable

    • Default: null

  • Parameter: multiValue

    • Default: null

productProperty_createBool

productProperty_createBool(productId, productVersion, packageVersion, propertyId, description=null, defaultValues=null)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: propertyId

  • Parameter: description

    • Default: null

  • Parameter: defaultValues

    • Default: null

productProperty_createObjects

productProperty_createObjects(productProperties)

  • Parameter: productProperties

productProperty_createUnicode

productProperty_createUnicode(productId, productVersion, packageVersion, propertyId, description=null, possibleValues=null, defaultValues=null, editable=null, multiValue=null)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: propertyId

  • Parameter: description

    • Default: null

  • Parameter: possibleValues

    • Default: null

  • Parameter: defaultValues

    • Default: null

  • Parameter: editable

    • Default: null

  • Parameter: multiValue

    • Default: null

productProperty_delete

productProperty_delete(productId, productVersion, packageVersion, propertyId)

  • Parameter: productId

  • Parameter: productVersion

  • Parameter: packageVersion

  • Parameter: propertyId

productProperty_deleteObjects

productProperty_deleteObjects(productProperties)

  • Parameter: productProperties

productProperty_getHashes

productProperty_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productProperty_getIdents

productProperty_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

productProperty_getObjects

productProperty_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productProperty_insertObject

productProperty_insertObject(productProperty)

  • Parameter: productProperty

productProperty_updateObject

productProperty_updateObject(productProperty)

  • Parameter: productProperty

productProperty_updateObjects

productProperty_updateObjects(productProperties)

  • Parameter: productProperties

productPropertyState_create

productPropertyState_create(productId, propertyId, objectId, values=null)

  • Parameter: productId

  • Parameter: propertyId

  • Parameter: objectId

  • Parameter: values

    • Default: null

productPropertyState_createObjects

productPropertyState_createObjects(productPropertyStates)

  • Parameter: productPropertyStates

productPropertyState_delete

productPropertyState_delete(productId, propertyId, objectId)

  • Parameter: productId

  • Parameter: propertyId

  • Parameter: objectId

productPropertyState_deleteObjects

productPropertyState_deleteObjects(productPropertyStates)

  • Parameter: productPropertyStates

productPropertyState_getHashes

productPropertyState_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productPropertyState_getIdents

productPropertyState_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

productPropertyState_getObjects

productPropertyState_getObjects(attributes=[], filter)

Add default objects to result for objects which do not exist in backend

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

productPropertyState_insertObject

productPropertyState_insertObject(productPropertyState)

  • Parameter: productPropertyState

productPropertyState_updateObject

productPropertyState_updateObject(productPropertyState)

  • Parameter: productPropertyState

productPropertyState_updateObjects

productPropertyState_updateObjects(productPropertyStates)

  • Parameter: productPropertyStates

readLog

readLog(type, objectId=null, maxSize=0)

  • Parameter: type

  • Parameter: objectId

    • Default: null

  • Parameter: maxSize

    • Default: 0

removeProductIdsFromLicensePool

removeProductIdsFromLicensePool(productIds, licensePoolId)

  • Parameter: productIds

  • Parameter: licensePoolId

removeSoftwareLicenseFromLicensePool

removeSoftwareLicenseFromLicensePool(softwareLicenseId, licensePoolId)

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

setActionRequestWhereOutdated

setActionRequestWhereOutdated(actionRequest, productId)

Set the specified actionRequest at every client that has not the version of the product with the given productId installed. The version is compared between the version installed on the client and the one available on the depot.

  • Parameter: actionRequest

  • Parameter: productId

Returns set : The IDs of clients where the actionRequest has been set.

setActionRequestWhereOutdatedWithDependencies

setActionRequestWhereOutdatedWithDependencies(actionRequest, productId)

Set the specified actionRequest for the given productId and dependencies at every client that hasn’t got the current version installed. The version is compared between the version installed on the client and the one available on the depot.

  • Parameter: actionRequest

  • Parameter: productId

Returns set : The IDs of clients where the actionRequest has been set.

setGeneralConfig

setGeneralConfig(config, objectId=null)

  • Parameter: config

  • Parameter: objectId

    • Default: null

setGeneralConfigValue

setGeneralConfigValue(key, value, objectId=null)

  • Parameter: key

  • Parameter: value

  • Parameter: objectId

    • Default: null

setHardwareInformation

setHardwareInformation(hostId, info)

  • Parameter: hostId

  • Parameter: info

setHostDescription

setHostDescription(hostId, description)

  • Parameter: hostId

  • Parameter: description

setHostInventoryNumber

setHostInventoryNumber(hostId, inventoryNumber)

  • Parameter: hostId

  • Parameter: inventoryNumber

setHostLastSeen

setHostLastSeen(hostId, timestamp)

  • Parameter: hostId

  • Parameter: timestamp

setHostNotes

setHostNotes(hostId, notes)

  • Parameter: hostId

  • Parameter: notes

setMacAddress

setMacAddress(hostId, mac)

  • Parameter: hostId

  • Parameter: mac

setMacAddresses

setMacAddresses(hostId, macs=[])

  • Parameter: hostId

  • Parameter: macs

    • Default: []

setNetworkConfig

setNetworkConfig(config, objectId=null)

  • Parameter: config

  • Parameter: objectId

    • Default: null

setOpsiHostKey

setOpsiHostKey(hostId, opsiHostKey)

  • Parameter: hostId

  • Parameter: opsiHostKey

setProductActionProgress

setProductActionProgress(productId, hostId, productActionProgress)

  • Parameter: productId

  • Parameter: hostId

  • Parameter: productActionProgress

setProductActionRequest

setProductActionRequest(productId, clientId, actionRequest)

  • Parameter: productId

  • Parameter: clientId

  • Parameter: actionRequest

setProductActionRequestForHostGroup

setProductActionRequestForHostGroup(hostGroupId, productId, actionRequest)

  • Parameter: hostGroupId

  • Parameter: productId

  • Parameter: actionRequest

setProductActionRequestForProductGroup

setProductActionRequestForProductGroup(hostGroupId, productGroupId, actionRequest)

  • Parameter: hostGroupId

  • Parameter: productGroupId

  • Parameter: actionRequest

setProductActionRequestWithDependencies

setProductActionRequestWithDependencies(productId, clientId, actionRequest)

Set the action request actionRequest for product with id productId on client clientId.

  • Parameter: productId

    • Type: str

    • Description: Id of the product.

  • Parameter: clientId

    • Type: str

    • Description: Client that should get the request set.

  • Parameter: actionRequest

    • Type: str

    • Description: The request to set.

setProductInstallationStatus

setProductInstallationStatus(productId, objectId, installationStatus)

  • Parameter: productId

  • Parameter: objectId

  • Parameter: installationStatus

setProductProperties

setProductProperties(productId, properties, objectId=null)

Set ProductPropertyStates as given. This will create product propert states for the given objectId if objectId is given. If objectId is None then this will alter all depots that already have existing ProductPropertyStates for the product and the given property IDs.

  • Parameter: productId

    • Type: str

    • Description: The ID of the product.

  • Parameter: properties

    • Type: dict[key] = str

    • Description: The properties to set. The key of the dict is the property ID and the value is the new value.

  • Parameter: objectId

    • Type: str or None

    • Default: null

    • Description: ID of the object to change. If this is None the values of depots with an existing ProductPropertyState will be changed.

Raises ValueError: If a ProductProperty of unhandled type is encountered., ValueError: If an attempt to set multiple values at a non-multivalue property is made., BackendMissingDataError: If ProductProperty or Product aren’t present.

setProductProperty

setProductProperty(productId, propertyId, value, objectId=null)

  • Parameter: productId

  • Parameter: propertyId

  • Parameter: value

  • Parameter: objectId

    • Default: null

setProductPropertyForHostGroup

setProductPropertyForHostGroup(productId, propertyId, propertyValue, groupId)

  • Parameter: productId

  • Parameter: propertyId

  • Parameter: propertyValue

  • Parameter: groupId

setProductState

setProductState(productId, objectId, installationStatus="", actionRequest="", productVersion="", packageVersion="", lastStateChange="", productActionProgress={})

  • Parameter: productId

  • Parameter: objectId

  • Parameter: installationStatus

    • Default: ""

  • Parameter: actionRequest

    • Default: ""

  • Parameter: productVersion

    • Default: ""

  • Parameter: packageVersion

    • Default: ""

  • Parameter: lastStateChange

    • Default: ""

  • Parameter: productActionProgress

    • Default: {}

setRights

setRights(path=null)

Setting rights for a specified path. If no path is given it will try to set the rights for the current depot. The current implementation requires "sudo opsi-setup --patch-sudoers-file" to be run before.

  • Parameter: path

    • Default: null

setSoftwareInformation

setSoftwareInformation(hostId, info)

  • Parameter: hostId

  • Parameter: info

setSoftwareLicenseUsage

setSoftwareLicenseUsage(hostId, licensePoolId, softwareLicenseId, licenseKey="", notes="")

  • Parameter: hostId

  • Parameter: licensePoolId

  • Parameter: softwareLicenseId

  • Parameter: licenseKey

    • Default: ""

  • Parameter: notes

    • Default: ""

setupWhereFailed

setupWhereFailed(productId)

Set the product with the id productId to 'setup' on every client where the action result is 'failed'. The action request will only be set if the depot the client is assigend to has a product installed where 'setup' can be set.

  • Parameter: productId

Returns set : the ID of all clients that have been processed.

setupWhereInstalled

setupWhereInstalled(productId)

Set the product with the id productId to 'setup' on every client where the installation status is 'installed'. The action request will only be set if the depot the client is assigend to has a product installed where 'setup' can be set.

  • Parameter: productId

Returns set : the ID of all clients that have been processed.

setupWhereNotInstalled

setupWhereNotInstalled(productId)

Sets the action request for the product with productId to 'setup' on all clients where the status of the product is not 'installed'. The action request will only be set if the depot the client is assigend to has a product installed where 'setup' can be set.

  • Parameter: productId

Returns set : the ID of all clients that have been processed.

setWindowsSoftwareIdsToLicensePool

setWindowsSoftwareIdsToLicensePool(windowsSoftwareIds, licensePoolId)

  • Parameter: windowsSoftwareIds

  • Parameter: licensePoolId

showDepotInfo

showDepotInfo()

softwareLicense_createConcurrent

softwareLicense_createConcurrent(id, licenseContractId, maxInstallations=null, boundToHost=null, expirationDate=null)

  • Parameter: id

  • Parameter: licenseContractId

  • Parameter: maxInstallations

    • Default: null

  • Parameter: boundToHost

    • Default: null

  • Parameter: expirationDate

    • Default: null

softwareLicense_createObjects

softwareLicense_createObjects(softwareLicenses)

  • Parameter: softwareLicenses

softwareLicense_createOEM

softwareLicense_createOEM(id, licenseContractId, maxInstallations=null, boundToHost=null, expirationDate=null)

  • Parameter: id

  • Parameter: licenseContractId

  • Parameter: maxInstallations

    • Default: null

  • Parameter: boundToHost

    • Default: null

  • Parameter: expirationDate

    • Default: null

softwareLicense_createRetail

softwareLicense_createRetail(id, licenseContractId, maxInstallations=null, boundToHost=null, expirationDate=null)

  • Parameter: id

  • Parameter: licenseContractId

  • Parameter: maxInstallations

    • Default: null

  • Parameter: boundToHost

    • Default: null

  • Parameter: expirationDate

    • Default: null

softwareLicense_createVolume

softwareLicense_createVolume(id, licenseContractId, maxInstallations=null, boundToHost=null, expirationDate=null)

  • Parameter: id

  • Parameter: licenseContractId

  • Parameter: maxInstallations

    • Default: null

  • Parameter: boundToHost

    • Default: null

  • Parameter: expirationDate

    • Default: null

softwareLicense_delete

softwareLicense_delete(id)

  • Parameter: id

softwareLicense_deleteObjects

softwareLicense_deleteObjects(softwareLicenses)

  • Parameter: softwareLicenses

softwareLicense_getHashes

softwareLicense_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

softwareLicense_getIdents

softwareLicense_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

softwareLicense_getObjects

softwareLicense_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

softwareLicense_insertObject

softwareLicense_insertObject(softwareLicense)

  • Parameter: softwareLicense

softwareLicense_updateObject

softwareLicense_updateObject(softwareLicense)

  • Parameter: softwareLicense

softwareLicense_updateObjects

softwareLicense_updateObjects(softwareLicenses)

  • Parameter: softwareLicenses

softwareLicenseToLicensePool_create

softwareLicenseToLicensePool_create(softwareLicenseId, licensePoolId, licenseKey=null)

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

  • Parameter: licenseKey

    • Default: null

softwareLicenseToLicensePool_createObjects

softwareLicenseToLicensePool_createObjects(softwareLicenseToLicensePools)

  • Parameter: softwareLicenseToLicensePools

softwareLicenseToLicensePool_delete

softwareLicenseToLicensePool_delete(softwareLicenseId, licensePoolId)

  • Parameter: softwareLicenseId

  • Parameter: licensePoolId

softwareLicenseToLicensePool_deleteObjects

softwareLicenseToLicensePool_deleteObjects(softwareLicenseToLicensePools)

  • Parameter: softwareLicenseToLicensePools

softwareLicenseToLicensePool_getHashes

softwareLicenseToLicensePool_getHashes(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

softwareLicenseToLicensePool_getIdents

softwareLicenseToLicensePool_getIdents(returnType="unicode", filter)

  • Parameter: returnType

    • Default: "unicode"

  • Optional Parameter: filter

    • Type: dict

softwareLicenseToLicensePool_getObjects

softwareLicenseToLicensePool_getObjects(attributes=[], filter)

  • Parameter: attributes

    • Default: []

  • Optional Parameter: filter

    • Type: dict

softwareLicenseToLicensePool_insertObject

softwareLicenseToLicensePool_insertObject(softwareLicenseToLicensePool)

  • Parameter: softwareLicenseToLicensePool

softwareLicenseToLicensePool_updateObject

softwareLicenseToLicensePool_updateObject(softwareLicenseToLicensePool)

  • Parameter: softwareLicenseToLicensePool

softwareLicenseToLicensePool_updateObjects

softwareLicenseToLicensePool_updateObjects(softwareLicenseToLicensePools)

  • Parameter: softwareLicenseToLicensePools

SSHCommand_createObject

SSHCommand_createObject(menuText, commands=[], position=0, needSudo=False, tooltipText=u"", parentMenuText=null)

  • Parameter: menuText

  • Parameter: commands

    • Default: []

  • Parameter: position

    • Default: 0

  • Parameter: needSudo

    • Default: False

  • Parameter: tooltipText

    • Default: u""

  • Parameter: parentMenuText

    • Default: null

SSHCommand_createObjects

SSHCommand_createObjects(commandList)

  • Parameter: commandList

SSHCommand_deleteObject

SSHCommand_deleteObject(menuText)

  • Parameter: menuText

SSHCommand_deleteObjects

SSHCommand_deleteObjects(menuTextList)

  • Parameter: menuTextList

SSHCommand_getObject

SSHCommand_getObject(menuText)

  • Parameter: menuText

SSHCommand_getObjects

SSHCommand_getObjects()

SSHCommand_updateObject

SSHCommand_updateObject(menuText, commands=null, position=null, needSudo=null, tooltipText=null, parentMenuText=null)

  • Parameter: menuText

  • Parameter: commands

    • Default: null

  • Parameter: position

    • Default: null

  • Parameter: needSudo

    • Default: null

  • Parameter: tooltipText

    • Default: null

  • Parameter: parentMenuText

    • Default: null

SSHCommand_updateObjects

SSHCommand_updateObjects(commandList)

  • Parameter: commandList

uninstallWhereInstalled

uninstallWhereInstalled(productId)

Set the product with the id productId to 'uninstall' on every client where the installation status is 'installed'. The action request will only be set if the depot the client is assigend to has a product installed where 'uninstall' can be set.

  • Parameter: productId

Returns set : the ID of all clients that have been processed.

unlockProduct

unlockProduct(productId, depotIds=[])

  • Parameter: productId

  • Parameter: depotIds

    • Default: []

unsetProductActionRequest

unsetProductActionRequest(productId, clientId)

  • Parameter: productId

  • Parameter: clientId

updateWhereInstalled

updateWhereInstalled(productId)

Set the product with the id productId to 'update' on every client where the installation status is 'installed'. The action request will only be set if the depot the client is assigend to has a product installed where 'update' can be set.

  • Parameter: productId

Returns set : the ID of all clients that have been processed.

updateWIMConfig

updateWIMConfig(productId)

  • Parameter: productId

updateWIMConfigFromPath

updateWIMConfigFromPath(path, targetProductId)

  • Parameter: path

  • Parameter: targetProductId

user_getCredentials

user_getCredentials(username=u"pcpatch", hostId=null)

Get the credentials of an opsi user. The information is stored in /etc/opsi/passwd.

  • Parameter: username

    • Default: u"pcpatch"

  • Parameter: hostId

    • Default: null

    • Description: Optional value that should be the calling host.

Returns dict : Dict with the keys password and rsaPrivateKey. If this is called with an valid hostId the data will be encrypted with the opsi host key.

user_setCredentials

user_setCredentials(username, password)

Set the password of an opsi user. The information is stored in /etc/opsi/passwd. The password will be encrypted with the opsi host key of the depot where the method is.

  • Parameter: username

  • Parameter: password

userIsAdmin

userIsAdmin()

userIsReadOnlyUser

userIsReadOnlyUser()

writeLog

writeLog(type, data, objectId=null, append=True)

  • Parameter: type

  • Parameter: data

  • Parameter: objectId

    • Default: null

  • Parameter: append

    • Default: True