Web Services Reference › Methods › Software › Priority, Reinstall, and Policy Enhancement › SetSoftwareJobContainerPriority

SetSoftwareJobContainerPriority

This method sets the priority of a software job container.

Parameters

xsd:string sessionId (m)

Specifies the session ID obtained from the login to the web service.

xsd:string softwareJobContainerId (m)

The UUID of the software job container whose priority is to be set.

xsd:long priority (m)

Can be 1 (highest) to 10 (lowest).

Return Values

This is a void method that does not expose a return value.

Remarks

None

OSIM

The DSM Web Services uses the methods listed in the subsequent section for OSIM functionality.

Considerations for Using OSIM Web Services

Consider the following factors when you use the OSIM web services:

• To use the ByName version of OSIM methods, the OSIM registered computers must have unique labels.
• A single session cannot have multiple listhandles opened simultaneously by a given method. You must close the listhandles opened by a method before opening it again using the same method. For example, within a given session, if you have opened a listhandle by calling the OpenOSImageList method, you must call the CloseOSImageList method before you make a call to the OpenOSImageList method.

CreateOSIMComputer

The CreateOSIMComputer method is used to create a new computer for OS deployment.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

dsm:createOSIMComputerProperties

Defines the properties to create a computer.

Return Values

xsd:string computerId

Returns the UUID if a computer is created.

Remarks

This web service preregisters a new computer.

RegisterComputerWithOSIM

The RegisterComputerWithOSIM method is used to register the Client Automation computer for OSIM deployment.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

xsd:string OSIMTargetID

Specifies the UUID of the computer.

xsd:string osimImage

Specifies the OSIM image.

Return Values

None

Remarks

None

RegisterComputerWithOSIMByName

The RegisterComputerWithOSIMByName method is used to register the Client Automation computer for OSIM deployment using the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osimTargetName

Specifies the host name of the target computer.

xsd:string osimImage

Specifies the OSIM image.

Return Values

None

Remarks

None

ActivateOSInstallation

The ActivateOSInstallation method activates a planned installation request for execution.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

xsd:boolean bWakeOnLAN

Specifies that the boot server must send a wake on LAN to the target computer.

xsd:boolean bReboot

Specifies that the boot server must send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

dsm:DateTime activateTime

Specifies the date and time for the installation. If start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

ActivateOSInstallationByName

The ActivateOSInstallationByName method activates a planned installation request for execution by using the host name.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the Web Service.

xsd:String OSIMTargetComputerLabel

Specifies the computer label of the target computer.

xsd:boolean bWakeOnLAN

Specifies the boot server to send a wake on LAN to the target computer.

xsd:boolean bReboot

Specifies the boot server to send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

dsm:DateTime activateTime

Specifies the date and time for the installation. If the start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

CancelOSInstallation

The CancelOSInstallation method cancels the OS installation.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

xsd:bool bForceCancel

Specifies that the OS installation must be canceled.

Note: You cannot cancel an OS installation job that in Installing state.

Return Values

None

Remarks

None

CancelOSInstallationByName

The CancelOSInstallationByName method cancels the OS installation of the give host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetComputerLabel

Specifies the computer label of the target computer.

xsd:bool bForceCancel

Specifies that the OS installation must be canceled.

Note: You cannot cancel an OS installation job that in Installing state.

Return Values

None

Remarks

None

ReActivateOSInstallation

The ReActivateOSInstallation method reactivates a canceled or a failed OS installation.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

xsd:boolean bWakeOnLAN

Specifies that the boot server must send a wake on LAN to the target computer.

xsd:boolean wakeOnLANSupplied

Specifies if the bWakeOnLAN value is specified.

xsd:boolean bReboot

Specifies that the boot server must send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd: boolean rebootSupplied

Specifies if the bReboot value is specified.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

xsd:boolean waitForBootServerSupplied

Specifies if the bWaitForBootServer value is specified.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

xsd:boolean waitForImagesSupplied

Specifies if the bWaitForImages value is specified.

dsm:DateTime activateTime

Specifies the date and time for the installation. If start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

ReActivateOSInstallationByName

The ReActivateOSInstallationByName method reactivates a canceled or a failed OS installation of the given target computer.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the Web Service.

xsd:String OSIMTargetComputerLabel

Specifies the computer label of the target computer.

xsd:boolean bWakeOnLAN

Specifies the boot server to send a wake on LAN to the target computer.

xsd:boolean wakeOnLANSupplied

Specifies if the bWakeOnLAN value is specified.

xsd:boolean bReboot

Specifies the boot server to send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd: boolean rebootSupplied

Specifies if the bReboot value is specified.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

xsd:boolean waitForBootServerSupplied

Specifies if the bWaitForBootServer value is specified.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

xsd:boolean waitForImagesSupplied

Specifies if the bWaitForImages value is specified.

dsm:DateTime activateTime

Specifies the date and time for the installation. If the start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

ReInstallOS

The ReInstallOS method reinstalls the current OS.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

xsd:boolean bWakeOnLAN

Specifies that the boot server must send a wake on LAN to the target computer.

xsd:boolean wakeOnLANSupplied

Specifies if the bWakeOnLAN value is specified.

xsd:boolean bReboot

Specifies that the boot server must send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd: boolean rebootSupplied

Specifies if the bReboot value is specified.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

xsd:boolean waitForBootServerSupplied

Specifies if the bWaitForBootServer value is specified.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

xsd:boolean waitForImagesSupplied

Specifies if the bWaitForImages value is specified.

dsm:DateTime activateTime

Specifies the date and time for the installation. If start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

ReInstallOSByName

The ReInstallOSByName method reinstalls the current OS by the host name of the target computer.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the Web Service.

xsd:String OSIMTargetComputerLabel

Specifies the computer label of the target computer.

xsd:boolean bWakeOnLAN

Specifies the boot server to send a wake on LAN to the target computer.

xsd:boolean wakeOnLANSupplied

Specifies if the bWakeOnLAN value is specified.

xsd:boolean bReboot

Specifies the boot server to send a reboot request to the target computer.

Note: For the target computer to reboot, the software delivery agent must be installed.

xsd: boolean rebootSupplied

Specifies if the bReboot value is specified.

xsd:boolean bWaitForBootServer

Specifies that the execution must wait until the target computer is assigned a boot server.

xsd:boolean waitForBootServerSupplied

Specifies if the bWaitForBootServer value is specified.

dsm:WS_OSIM_DEPLOY bWaitForImages

Specifies if the manager must wait for the OS images.

xsd:boolean waitForImagesSupplied

Specifies if the bWaitForImages value is specified.

dsm:DateTime activateTime

Specifies the date and time for the installation. If the start date is not specified, the installation begins immediately.

Return Values

None

Remarks

None

DeregisterOSIMComputer

The DeRegisterOSIMComputer method removes a target computer from OSIM managed systems using the MAC address of the target computer.

Note: This method does not delete the target computer from the Client Automation MDB. If you do not remove the computer from the network and do not disable PXE, the computer reregisters with OSIM during the boot process.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the OSIM computer.

Return Values

None

Remarks

None

DeRegisterOSIMComputerByName

The DeRegisterOSIMComputerByName method removes a target computer from the OSIM managed systems using the host name of the target computer.

Note: This method does not delete the target computer from the Client Automation MDB. If you do not remove the computer from the network and do not disable PXE, the computer re-registers with OSIM during the boot process.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osimTargetLabel

Specifies the computer label of the target computer.

Return Values

None

Remarks

None

GetUnnamedOSIMRegisteredComputers

The GetUnnamedOSIMRegisteredComputers method fetches the list of computers that are registered with OSIM from the network but not during discovered hardware. These computers show a MAC address and not the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

Return Values

dsm:ArrayOfOSIMTargetProperties

Array of OSIM target properties, one for each OSIM registered computer. The array contains the following properties of the target computers:

• Name—Name of the Target. For unnamed OSIM targets, this parameters returns empty string.
• MAC address—MAC Address of the target
• Host name—Host Name of the target
• Network address—Network address of the target
• Created at—Creation date
• Boot status—Boot status of the target
• Name of attached boot server—Name of the boot server the target is associated with.

Remarks

None

GetUnmanagedOSIMRegisteredComputers

The GetUnmanagedOSIMRegisteredComputers fetches the list of computers that are in an unmanaged state.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

Return Values

dsm:ArrayOfOSIMTargetProperties

Array of the OSIM target properties, one for each unmanaged computer. The array contains the following properties of the target computers:

• Name—Name of the Target. For unnamed OSIM targets, this parameters returns the MAC address of the computer.
• MAC address—MAC Address of the target
• Host name—Host Name of the target
• Network address—Network address of the target
• Created at—Creation date
• Boot status—Boot status of the target
• Name of attached boot server—Name of the boot server the target is associated with.

Remarks

None

GetOSInstallationRequest

The GetOSInstallationRequest method is used to retrieve the installation request details for the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

dsm:WS_OSIM_CONF_TYPE

Specifies the type of installation request.

xsd:bool confTypeSupplied

Specifies if the configuration type is specified.

Return Values

dsm:ArrayOfOSIMProperties

Displays a list of OSIM installation request attributes. The array contains the following properties of the target computers:

• Target name
• Target UUID
• Image name
• Image UUID
• Boot status
• Configuration state
• Date of last status change
• Activation time

  Note: Activation time is not available for Planned requests.

The following details are available only for scheduled requests:

• Wake on LAN required
• Reboot required
• Wait for boot server required
• Wait for images

Remarks

None.

GetOSInstallationRequestByName

The GetOSInstallationRequestByName method is used to retrieve the installation request details for the target computer by using the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetLabel

Specifies the computer label of the target computer.

dsm:WS_OSIM_CONF_TYPE

Specifies the type of installation request.

xsd:bool confTypeSupplied

Specifies if the configuration type is specified.

Return Values

dsm:ArrayOfOSIMProperties

Displays the list of OSIM installation request attributes.The array contains the following properties of the target computers:

• Target name
• Target UUID
• Image name
• Image UUID
• Boot status
• Configuration state
• Date of last status change
• Activation time

  Note: Activation time is not available for Planned requests.

The following details are available only for scheduled requests:

• Wake on LAN required
• Reboot required
• Wait for boot server required
• Wait for images

Remarks

None.

GetInstallationRequestList

The GetInstallationRequestList method is used to request the list of installation requests for the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

Return Values

dsm:ArrayOfOSIMTargetInstallationRequestsProperties

Displays the installation requests for the target computer. The array contains the installation request properties, one for each Installation Request:

• Target name
• Target UUID
• Image name
• Image UUID
• Boot status
• Configuration state
• Date of last status change
• Activation time

  Note: Activation time is not available for Planned requests.

The following details are available only for scheduled requests:

• Wake on LAN required
• Reboot required
• Wait for boot server required
• Wait for images

Remarks

None.

GetInstallationRequestListByName

The GetInstallationRequestListByName method is used to retrieve the list of installation requests for the target computer by using the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetLabel

Specifies the computer label of the target computer.

Return Values

dsm:ArrayOfOSIMTargetInstallationRequestsProperties

Displays the installation requests for the target computer. The array contains the installation request properties for the target computer:

• Target name
• Target UUID
• Image name
• Image UUID
• Boot status
• Configuration state
• Date of last status change
• Activation time

  Note: Activation time is not available for Planned requests.

The following details are available only for scheduled requests:

• Wake on LAN required
• Reboot required
• Wait for boot server required
• Wait for images

Remarks

None

DeleteOSInstallationRequest

The DeleteOSInstallationRequest method is used to delete a planned or scheduled installation of an OSIM target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

dsm:WS_OSIM_IR_STATUS irStatus

Specifies the installation request status of the OSIM computer.

Return Values

None

Remarks

None

DeleteOSInstallationRequestByName

The DeleteOSInstallationRequestByName method is used to delete a planned or scheduled installation of an OSIM target computer by using the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetLabel

Specifies the computer label of the target computer.

dsm:WS_OSIM_IR_STATUS irStatus

Specifies the installation request status of the OSIM computer.

Return Values

None

Remarks

None

SetOSIMComputerMACAddressByName

The SetOSIMComputerMACAddressByName method is used to change the MAC address information and the installation requests by using the host name of a target computer.

Note: You can apply this method only when there is no scheduled request. If there is a scheduled request, it must be of Failed or Stopped status .

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetLabel

Specifies the computer label of the target computer.

xsd:string MACAddress

Specifies the new MAC address of the target computer.

Return Values

None

Remarks

None

SetOSInstallationParameters

The SetOSInstallationParameters method updates multiple OS installation parameters for a particular target identified by MAC address.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osimTargetMACAddress

Specifies the MAC address of the target whose OS installation parameters are to be updated.

ArrayOfOSIMParameters arrParams

Specifies an array of installation parameters to be updated.

SetOSInstallationParametersByName

The SetOSInstallationParametersByName method updates multiple OS installation parameters for a particular target identified by computer label.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string string osimTargetComputerLabel

Specifies the computer label of the target whose OS installation parameters are to be updated.

ArrayOfOSIMParameters arrParams

Specifies an array of installation parameters to be updated.

GetOSInstallationParameters

The GetOSInstallationParameters method is used to fetch the installation parameter settings with the descriptions of planned, scheduled, or current installation request for the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

Return values

dsm:ArrayOfOSIMTargetPropertiesWithDesc

Array of the installation parameters of the target computer.

Remarks

None

GetOSInstallationParametersByName

The GetOSInstallationParametersByName method is used to fetch the installation parameter settings with the descriptions of planned, scheduled, or current installation request by using the host name of the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetLabel

Specifies the computer label of the target computer.

Return values

dsm:ArrayOfOSIMTargetPropertiesWithDesc

Array of the installation parameters of the target computer.

Remarks

None

SetOSInstallationParameter

The SetOSInstallationParameter method changes the OS installation parameter of the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the target computer.

xsd:string installParameterName

Specifies the parameter name of the target computer.

xsd:string installParameterValue

Specifies the new parameter value of the target computer.

Return Values

None

Remarks

None

SetOSInstallationParameterByName

The SetOSInstallationParameterByName method changes the OS installation parameter by the host name of the target computer.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:String OSIMTargetComputerLabel

Specifies the computer label of the target computer.

xsd:string installParameterName

Specifies the parameter name of the target computer.

xsd:string installParameterValue

Specifies the new parameter value of the target computer.

Return Values

None

Remarks

None

OpenOSImageList

The OpenOSImageList method fetches the list of all available OS images.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:bool isBootServerNameSupplied

Specifies if the boot server name is entered.

xsd:string bootServerName

Specifies the name of the boot server.

dsm:ArrayOfOSImageFilter

Specifies the filter on the OS image properties.

xsd:bool matchAll

Specifies the condition on the filter properties.

dsm:OSIMAGEPROPERTY sortProperty

Specifies the OS image property that you want to sort.

xsd:bool ascending

Specifies if the sorting is in ascending order.

Return Values

xsd:long OpenListHandle

Specifies the numeric handle to a list of OS images that can be passed to GetOSImages.

xsd:long totalNoOfImages

Specifies the total number of images in the list returned by the OpenListHandle parameter.

GetOSImages

TheGetOSImages method retrieves the properties of the OS images from OpenOSImageList.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the web service.

xsd:long listHandle

Specifies the numeric handle to a list as returned by a previous call to OpenOSImageList.

xsd:long noOfImages

Specifies the total number of OS images to fetch from the list. This must be less than or equal to the total number in the list as returned by a previous call to OpenOSImageList

Return Values

dsm:ArrayOfOSImageProperties

Displays the list of the open OS images.

Remarks

None

CloseOSImageList

The CloseOSImageList method closes the list handle.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the list handle for the list of OS images.

Return Values

None

Remarks

None

GetBootImageList

The GetBootImageList method fetches all the available boot images.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:bool isBootServerNameSupplied

Specifies if the boot server name is entered.

xsd:string bootServerName

Specifies the name of the boot server.

Return Values

dsm:ArrayOfOSIMImageProperties

Array of list of boot image properties. The array contains the following boot image properties:

• Image name—Name of the image
• Type indicator—Boot image type
• Platform—boot image platform
• Registered at—Date when the boot image was registered at the domain manager
• SD package name—Name of the related SD package
• SD package version—Version of the related SD package
• SD package comment—Comment related with the SD package
• Image support information—Information about the feature support of the image, for example, FIPS 140-2

AssignOSIMTargetsToBootServer

The AssignOSIMTargetsToBootServer method assigns a list of target computers using the MAC address to a boot server.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string bootServerName

Specifies the name of the boot server.

dsm:ArrayOfstring osimTargetMACAddress

Specifies the list of MAC addresses of target computers.

Return Values

None

Remarks

None

AssignOSIMTargetsToBootServerByName

The AssignOSIMTargetsToBootServerByName method assigns a list of target computers using the host names to a boot server.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string bootServerName

Specifies the name of the boot server.

dsm:ArrayOfstring osimTargetLabel

Specifies the list of computer labels of target computers.

Return Values

None

Remarks

None

OpenScalabilityServerList

The OpenScalabilityServerList fetches a list of all scalability servers registered with a domain manager.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ScalabilityServerPropertiesRequired

Specifies the properties required to fetch a scalability server from the list.

Return Values

xsd:long OpenListHandle

Specifies the numeric handle to a list of servers that is used by GetScalabilityServers.

xsd:long totalNoOfQueries

Specifies the total number of images in the list returned by the OpenListHandle parameter..

Remarks

This method returns the size of the list and a handle to the list that can be used with the GetScalabilityServers method.

GetScalabilityServers

The GetScalabilityServers method retrieves the properties of the scalability servers from scalability server list.

Parameters

xsd:string sessionId

Specifies the session id obtained from the login to the Web Service.

xsd:long listHandle

Specifies the numeric handle to a list, returned by a previous call to OpenScalabilityServerList.

xsd:long noOfServers(m)

Specifies the total number of servers to get from the list. This must be less than or equal to the total number in the list, returned by a previous call to OpenScalabilityServerList

Return Values

dsm:ArrayOfServerProperties GetServerReturn

Specifies an Array of scalability server properties, one for each server.

Remarks

None

CloseScalabilityServerList

The CloseScalabilityServerList closes the list of open scalability servers.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the total number of images in the list returned by the OpenListHandle parameter.

Return Values

None

Remarks

None

SearchComputerProperty

The SearchComputerProperty method checks if a computer with the given property value exists.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string propertyValue

Specifies the computer property value that you want to search for.

dsm:PROPERTY-TYPE propType

Identifies the type of property.

Return Values

None

Remarks

None

GetOSImageParameters

The GetOSImageParameters method fetches the default parameter settings of an OS image.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osImage

Specifies the OS image name. The default parameter settings of the OS image specified will be retrieved.

Return Values

dsm:ArrayOfOSIMPropertiesWithDesc

Array of the default parameters of the OS image.

Remarks

None

GetBootServerList

The GetBootServerList method fetches the list of boot servers registered with the domain manager.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

Return Values

dsm:ArrayOfBootServerProperties

Array of boot server properties registered with the domain manager. The array contains the following boot server properties:

• BootServer Name—Name of the Bootserver
• Access method—Access method configured
• Boot server status—Boot server status
• Last report—Timestamp last report
• Last report requested—Timestamp last report request
• Last response—Timestamp last heard
• MPC status—MPC status
• NFS support—NFS support
• PXE interfaces
• SD agent package (Linux)—SD agent package (Linux)
• SD agent package (Windows)—SD agent package (Windows)
• SD agent package r11 (Windows)—SD agent package r11 (Windows)

Remarks

None

GetOSImageDeployedBootServers

The GetOSImageDeployedBootServers fetches the list of the boot servers where the OS image is registered.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osImage

Specifies the name of the OS image.

Return Values

dsm:ArrayOfBootServerProperties

Array of boot server properties registered with the domain manager. The array contains the following boot server properties:

• BootServer Name—Name of the Bootserver
• Access method—Access method configured
• Boot server status—Boot server status
• Last report—Timestamp last report
• Last report requested—Timestamp last report request
• Last response—Timestamp last heard
• MPC status—MPC status
• NFS support—NFS support
• PXE interfaces
• SD agent package (Linux)—SD agent package (Linux)
• SD agent package (Windows)—SD agent package (Windows)
• SD agent package r11 (Windows)—SD agent package r11 (Windows)

Remarks

None

GetBootImageDeployedBootServers

The GetBootImageDeployedBootServers method fetches the list of all the boot servers where the Boot image is registered.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string bootImage

Specifies the name of the boot image.

Return Values

dsm:ArrayOfBootServerProperties

Array of boot server properties registered with the domain manager. The array contains the following boot server properties:

• BootServer Name—Name of the Bootserver
• Access method—Access method configured
• Boot server status—Boot server status
• Last report—Timestamp last report
• Last report requested—Timestamp last report request
• Last response—Timestamp last heard
• MPC status—MPC status
• NFS support—NFS support
• PXE interfaces
• SD agent package (Linux)—SD agent package (Linux)
• SD agent package (Windows)—SD agent package (Windows)
• SD agent package r11 (Windows)—SD agent package r11 (Windows)

Remarks

None

DeRegisterOSImage

The DeRegisterOSImage method deregisters the OS image from the domain manager.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osImage

Specifies the name of the OS image.

Return Values

None

Remarks

None

DeRegisterBootImage

The DeRegisterBootImage method deregisters the boot image from the domain manager.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string bootImage

Specifies the name of the boot image.

Return Values

None

Remarks

None

AssignOSImageToOSIMTargets

The AssignOSImageToOSIMTargets method assigns an OS image to target computers.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:string osImage

Specifies the name of the OS image.

dsm:ArrayOfstring osimTargetNames

Specifies an array of the list of computer labels for target computers.

Return Values

None

Remarks

None

OpenOSIMTargetList

The OpenOSIMTargetList method lists the handle of the registered OSIM target computers.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:bool isBootServerNameSupplied

Specifies if the boot server name is entered.

xsd:string bootServerName

Specifies the name of the boot server.

dsm:ArrayOfOSImageFilter

Specifies the filter on the OS image properties.

xsd:bool matchAll

Specifies the condition on the filter properties.

dsm:OSIMAGEPROPERTY sortProperty

Specifies the OS Image property that you want to sort.

xsd:bool ascending

Specifies sorting in an ascending order.

Return Values

None

Remarks

None

GetOSIMTargets

The GetOSIMTargets method fetches the list of OSIM target computers.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the list handle of the list of OS images.

long totalNoOfOSIMTargets

Specifies the number Of OSIM target computers.

Return Values

dsm:ArrayOfTargetProperties arrayofTargetProperties

Returns an array of target properties.

Remarks

None

CloseOSIMTargetList

The CloseOSIMTargetListmethod is used to close the OSIM target computers list handle.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the list handle of the list of OS images.

Return Values

None

Remarks

None

GetOSIMTarget

The GetOSIMTarget method fetches the properties of an OSIM Computer based on OSIM ComputerMACAddress

Parameters

xsd:string sessionId (m)

Specifies the session identifier.

xsd:string OSIMTargetMACAddress

Specifies the MAC address of the OSIM computer.

Return Values

dsm:ArrayOfOSIMProperties arrayOfOSIMTargetProperties

Returns an array that includes the following properties for the target computer:

• Name—Name of the Target
• MAC address—MAC Address of the target
• Host name—Host Name of the target
• Network address—Network address of the target
• Created at—Creation date
• Boot status—Boot status of the target
• Name of attached boot server—Name of the boot server the target is associated with
• Name of OS image in the planned installation request—Name of the OS image involved with the planned installation request if there is any
• Name of OS image in the scheduled installation request—Name of the OS image involved with the scheduled installation request if there is any
• The status of the scheduled installation request—Status of the scheduled installation request if there is any scheduled installation

Remarks

None

GetOSIMTargetByName

The GetOSIMTargetByName method fetches the properties of OSIM Computer based on OSIM ComputerLabel.

Parameters

xsd:string sessionId (m)

Specifies the session identifier.

xsd:string OSIMTargetLabel

Specifies the label of the OSIM computer.

Return Values

dsm:ArrayOfOSIMProperties arrayOfOSIMTargetProperties

Returns an array that includes the following properties for the target computer:

• Name—Name of the Target
• MAC address—MAC Address of the target
• Host name—Host Name of the target
• Network address—Network address of the target
• Created at—Creation date
• Boot status—Boot status of the target
• Name of attached boot server—Name of the boot server the target is associated with
• Name of OS image in the planned installation request—Name of the OS image involved with the planned installation request if there is any
• Name of OS image in the scheduled installation request—Name of the OS image involved with the scheduled installation request if there is any
• The status of the scheduled installation request—Status of the scheduled installation request if there is any scheduled installation

Remarks

None

GetOSImages2

The GetOSImages2method returns a list of OS images from a specified index number. For example, if the complete list of OS images has 10 images (from 0-9) and if you want to read from the fifth position, this method can return a list with images from 5 to 9.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the numeric handle to a list as returned by a previous call to OpenOSImageList.

xsd:long noOfImages

Specifies the number of objects you want to retrieve from the startIndex position. This number must be less than or equal to the total number in the list as returned by a previous call to OpenOSImageList.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

Return Values

dsm:ArrayOfOSImageProperties

Displays an array of OS image properties for the images that are returned from the result set.

Remarks

None

GetOSIMTargets2

The GetOSIMTargets2 method returns a list of OSIM registered computers from a specified index number. For example, if the complete list of OSIM registered computer has 10 computers (from 0-9) and if you want to read from the fifth position, this method can return a list with computers from 5 to 9.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:long listHandle

Specifies the list handle of the list of OS images.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

Xsd:long noOfTargets

Specifies the number of objects you want to retrieve from the startIndex position.

Return Values

dsm:ArrayOfTargetProperties

Array of OSIM target properties, one for each OSIM target computer.

Remarks

None

GetOSIMTargetList

The GetOSIMTargetList method returns the OSIM registered computers.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:bool isBootServerNameSupplied

Specifies whether the boot server name is entered.

xsd:string bootServerName

Specifies the name of the boot server.

dsm:ArrayOfOSIMTargetFilter2 filterArray

Specifies the filter on the OSIM computer properties.

xsd:boolean matchall

Specifies whether you want all the filter conditions to be satisfied. Set the parameter to True to perform an AND operation. Set the parameter to False to perform an OR operation.

dsm:OSIMTARGETPROPERTY2 sortProperty

Specifies the property based on which you want to sort the results.

xsd:boolean sortAscending

Specifies whether you want to sort the list in ascending order.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

Xsd:long noOfTargetsRequired

Specifies the number of objects you want to retrieve from the startIndex position.

Xsd:boolean refreshList

Specifies whether you want to recompute the result set for each call.

Return Values

dsm:ArrayOfTargetProperties2 arrayOfOSIMTargets

Contains an array of OSIM target properties, one for each OSIM target computer.

xsd:long totalNumberOfTargets

Contains the total number of computers matching the filter condition.

Remarks:

Even though the interface contains parameters related to filtering, the method does not support filtering operations.

SetOSInstallationParameter2

The SetOSInstallationParameter2 method changes the OS installation parameters for an array of computers identified by MACAddress.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring osimTargetMACAddress

Specifies list of MAC addresses of target computers.

xsd:string installParameterName

Specifies the parameter name of the OS installation parameter you want to change.

xsd:string installParameterValue

Specifies the OS installation parameter value you want to change. To update the default value, specify NULL.

Return Values

None

Remarks

None

SetOSInstallationParameterByName2

The SetOSInstallationParameterByName2 method changes the OS installation parameter for an array of computers identified by the host name.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring osimTargetComputerLabel (m)

Specifies the list of computer labels of the target computers.

xsd:string installParameterName

Specifies the parameter name of the OS installation parameter you want to change.

xsd:string installParameterValue

Specifies the OS installation parameter value you want to change. To update the default value, specify NULL.

Return Values

None

Remarks

None

GetOSIMParameterDefaults

The GetOSIMParameterDefaults method returns the supported values for an OS Installation parameter for OSIM Computers identified by MACAddress. For example, some of the OSIM parameters like, Time Zone, Language, and so on, have a set of valid values list for OS Image.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring osimTargetMACAddress

Specifies list of MAC addresses of target computers.

xsd:string paramName

Specifies the name of the parameter for which you want to retrieve the valid values.

Return Values

dsm:ArrayOfstring defaults

Returns an array of valid values for the specified parameter.

GetOSIMParameterDefaultsByName

The GetOSIMParameterDefaultsByName method returns the supported values for an OS Installation parameter for OSIM Computers identified by the host name. For example, some of the OSIM parameters like, Time Zone, Language, and so on, have a set of valid values list for OS Image.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm:ArrayOfstring osimTargetComputerLabel

Specifies the list of computer labels of target computers.

xsd:string paramName

Specifies the name of the parameter for which you want to retrieve the valid values.

Return Values

dsm:ArrayOfstring defaults

Returns an array of valid values for the specified parameter.

GetBootImageList2

The GetBootImageList2 method fetches all the registered boot images in a domain manager. This method also supports the sort and filter operations.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

xsd:bool isBootServerNameSupplied

Specifies if the boot server name is entered.

xsd:string bootServerName

Specifies the name of the boot server.

dsm: ArrayOfBootImageFilter filterArray

Specifies an array of filter conditions on boot image properties.

dsm:BootImageProperty sortProperty

Specifies the property based on which you want to sort the results.

xsd:boolean sortAscending

Specifies whether you want to sort the list in ascending order.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

xsd:long numRequired

Specifies the number of objects you want to retrieve from the startIndex position.

Xsd:boolean refreshList

Specifies whether you want to recompute the result set for each call.

Return Values

xsd:long totalNumImages

Contains the total number of images available for the specified filter condition.

dsm: ArrayOfBootImageProperties biPropsArray

Contains an array of boot image properties.

GetBootServerList2

The GetBootServerList2 method returns the boot servers in the domain manager. This method supports the sort and filter operations also.

Parameters

xsd:string sessionId

Specifies the session ID obtained from the DSM web services login.

dsm: ArrayOfBootServerFilter filterArray

Specifies an array of filter conditions on boot server properties.

dsm:BootServerProperty sortProperty

Specifies the boot server property based on which you want to sort the servers.

xsd:boolean ascending

Specifies whether you want to sort the boot servers in ascending order. If set to True, the servers are sorted in ascending order based on the sort property you specified.

Xsd:long index

Specifies an index number from which you want the items must be returned from the result set. The index is zero-based.

xsd:long numRequired

Specifies the number of boot servers to get from the specified index number.

Xsd:boolean refreshList

Specifies whether you want to recompute the result set for each call.

Return Values

xsd:long totalNumServers

Contains the total number of boot server available for the specified filter condition.

dsm: ArrayOfBootServerProperties biPropsArray

Contains an array of boot server properties.