exports/Set-SysManOperatingSystem.ps1
|
<# .Synopsis Update or create an operating system. .Description Update or create an operating system. .Link https://docs.microsoft.com/en-us/powershell/module/sysman.webapi/set-sysmanoperatingsystem #> function Set-SysManOperatingSystem { [OutputType('SysMan.Powershell.Models.IOperatingSystem', 'SysMan.Powershell.Models.IApiErrorMessage')] [CmdletBinding(DefaultParameterSetName='Put', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] [SysMan.Powershell.Description('Update or create an operating system.')] param( [Parameter(Mandatory, HelpMessage='The id of the operating system')] [SysMan.Powershell.Category('Path')] [System.Int64] ${Id}, [Parameter(ParameterSetName='Put', ValueFromPipeline, HelpMessage='Updates or creates a operating sytem')] [SysMan.Powershell.Category('Body')] [SysMan.Powershell.Models.IUpsertOperatingSystemCommand] ${Cmd}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The advertisementId is used to distinguished which of the Task sequences that should be used on the specifiedcollection (based on the collectionId).')] [SysMan.Powershell.Category('Body')] [System.String] ${AdvertisementId}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The collection the client that is installing this operating system will be placed in')] [SysMan.Powershell.Category('Body')] [System.String] ${CollectionId}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The description')] [SysMan.Powershell.Category('Body')] [System.String] ${Description}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The id of operating system to update. Set to null if new operating system object should be created.')] [SysMan.Powershell.Category('Body')] [System.Int64] ${Id1}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The edition of the image')] [SysMan.Powershell.Category('Body')] [System.Int32] ${ImageIndex}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The id of the image')] [SysMan.Powershell.Category('Body')] [System.String] ${ImagePackageId}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='If the provided operating system is a template operating system. A template operating system cannot be installedand exists only to provide a way to inherit configuration down to the child operating systems (example: Driver configuration, Hardware Model etc.).')] [SysMan.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] ${IsTemplate}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='If the operating system is in test. Defaults to false when creating an operating system. During an update and if null the value will be ignored (old value preserved).')] [SysMan.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] ${IsTest}, [Parameter(ParameterSetName='PutExpanded', Mandatory, HelpMessage='The name')] [SysMan.Powershell.Category('Body')] [System.String] ${Name}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The parent operating system (template) that this operating system belongs to.')] [SysMan.Powershell.Category('Body')] [System.Int64] ${ParentOperatingSystemId}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The type of operating system')] [SysMan.Powershell.Category('Body')] [System.String] ${Type}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='Unattend package id')] [SysMan.Powershell.Category('Body')] [System.String] ${UnattendFile}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='Unattend package id')] [SysMan.Powershell.Category('Body')] [System.String] ${UnattendPackageId}, [Parameter(ParameterSetName='PutExpanded', HelpMessage='The collectionId clients should be put in when upgrading (in place upgrade) to another Operating System')] [SysMan.Powershell.Category('Body')] [System.String] ${UpgradeCollectionId}, [Parameter(DontShow, HelpMessage='Wait for .NET debugger to attach')] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${Break}, [Parameter(DontShow, HelpMessage='SendAsync Pipeline Steps to be appended to the front of the pipeline')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [SysMan.Powershell.Runtime.SendAsyncStep[]] ${HttpPipelineAppend}, [Parameter(DontShow, HelpMessage='SendAsync Pipeline Steps to be prepended to the front of the pipeline')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [SysMan.Powershell.Runtime.SendAsyncStep[]] ${HttpPipelinePrepend}, [Parameter(DontShow, HelpMessage='The URI for the proxy server to use')] [SysMan.Powershell.Category('Runtime')] [System.Uri] ${Proxy}, [Parameter(DontShow, HelpMessage='Credentials for a proxy server to use for the remote call')] [ValidateNotNull()] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] ${ProxyCredential}, [Parameter(DontShow, HelpMessage='Use the default credentials for the proxy')] [SysMan.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PsCmdlet.ParameterSetName $mapping = @{ Put = 'SysMan.WebApi.private\Set-SysManOperatingSystem_Put'; PutExpanded = 'SysMan.WebApi.private\Set-SysManOperatingSystem_PutExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($myInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |