Configuring New Distribution Connection
REST APIs are enabled with AdminStudio Enterprise Edition.
When you send this request, it will setup new distribution connection.
| Request Type | Description |
|---|---|
| API | http://localhost:8086/catalog/distributionconnections \{ "Name" : "ConfigMgr", "PluginID" : "13", "ServerAddress" : "00.00.000.000", "SiteCode" : "XXX", "DistributionWindowsAuthentication" : "false", "DistributionUser" : "XX\\\\XXXXX", "DistributionPassword" : "XXXXX", "SharePath" : "\\\\\\\\00.00.000.000\\\\Publish", "ShareWindowsAuthentication" : "false", "ShareUserName" : "XX\\\\XXXXX", "SharePassword" : "XXXXX", "ScriptFile" :"Path of PS1 script file", "ScriptParameters" :"-Site \[SiteCode\],-ServerName \[Server\],- ProductName \[ProductName\],-Version \[Version\],-Vendor \[Vendor\],-SetupType \[SetupType\],-language \[Language\],-Install \[InstallCmdLine\],-UnInstall \[<br/>UnInstallCmdLine\],-Platform \[Platform\],-Icon \[IconPath\],-PublishFolder \[PackagePublishFolder\],-Transform \[TransformFilePath\],-PublishPath \[PackagePublishPath\],-Repair \[RepairCommandLine\]" \} |
| Method | POST |
| Parameters | List all parameters in the following format: Name = Use to specify the name of this new named connection to a distribution system. PluginID = Use to specify the plug-in with which the distribution system is associated. This parameter is mapped to the object identifier (OID) of the ASCMSupportedPackageTypes database table; you can provide any value available in this table to identify the plug-in. ServerAddress = Use to specify the distribution server address. SiteCode = When connecting to a ConfigMgr (Formerly called as System Center Configuration Manager) distribution system, use to specify the site code. DistributionWindowsAuthentication = Use to specify whether the distribution connection should use Windows Authentication or a custom user name and password. Available options are. False = Do not use Windows Authentication True = Use Windows Authentication DistributionUser = If not using Windows Authentication, use this parameter to specify the user name to use when connecting to the distribution system. DistributionPassword = If not using Windows Authentication, use this parameter to specify the password to use when connecting to the distribution system. SharePath = Use to specify the path to which packages are published. SharePath can be given with placeholders. Supported placeholder include: ProductName, Vendor, Version, SetupType, Platform, and Language. ShareWindowsAuthentication = Use to specify whether the share path connection should use Windows Authentication or a custom user name and password. Available options are. False = Do not use Windows Authentication True = Use Windows Authentication ShareUserName = If not using Windows Authentication, use this parameter to specify the user name to use when connecting to the share path. SharePassword = If not using Windows Authentication, use this parameter to specify the password to use when connecting to the share path. ScriptFile = Use to specify the path of the PS1 file. |
| Parameters (Continued) | ScriptParameters = Used to specify a PowerShell script parameters with the relevant AdminStudio placeholders. Available placeholders are: [ProductName] [Vendor] [Version] [PackagePublishPath] [InstallCmdLine] [UnInstallCmdLine] [Platform] [RepairCommandLine] [Language] [PackagePublishFolder] [TransformFilePath] [IconPath] [SetupType] |
| Connection Info | Provides the connection information of the package as mentioned in Setting Up Connection to Run REST APIs |
| Response | <response> <HasFault>false</HasFault><headers><httpHeaders><Content-Length>483</Content-Length><Accept-Encoding>gzip, deflate, br</Accept-Encoding> <Host>localhost:8086</Host><Content-Type>application/json</Content-Type><Accept>*/*</Accept><Postman-Token>bf0dee20-81f0-4ba2-99ab-a623e1d71fc5</Postman-Token><User-Agent>PostmanRuntime/7.26.10</User-Agent><Connection>keep-alive</Connection></httpHeaders><request></request></headers><summary /> \<data\>true\</data\> </response> |