SMS_GetCollectionIDFromName

Owned by Martin Gudme Søndergaard
May 23, 2022
1 min read

SMS_GetCollectionIDFromName(sSMSServer, sCollectionName, sUserName, sPassword)

Option

Description

Type

sSMSServer

The SMS Main Site Server

String

sCollectionName

The SMS collection to add the unit to.

String

sUserName

Account performing the action on SMS server

String

sPassword

The password for the above account.

String

Return Type

Boolean, TRUE if function completed successfully.

Description

Gets the collection id from a named collection on the specified SMS server.
The retrieved ID will be returned in gsValue.
Note that the query is performed on the server and therefore you must be sure to have the right permissions.

Specify * as password to let CapaInstaller decrypt a password already specified by CapaInstaller in registry.
Notes:
sSMSServer: SMS Main Server. Sub Site Servers are not supported. sCollectionName: The SMS Collection must exist in the Collection.

Example

<Add Function Scripting Guidelines here>

bStatus=True
If bStatus Then bStatus=IncludeScript("customlib.cis")
If bStatus Then bStatus=IncludeScriptingLibrary("CapaInstaller Scripting Library.cin")
If bStatus Then bStatus=Job_Start("WS","Get SMS site code","1.0","Capalib_test.log","INSTALL")
If bStatus Then bStatus=SMS_GetCollectionIDFromName("SMSSRV01","All Windows NT Systems" DOMAIN\Admin","Password")
Job_End(bStatus)

See Also

SMS_GetSiteCode SMS_GetUnitIDFromName SMS_AddUnitToCollection