Public/Set-CCMDNSSuffix.ps1
|
function Set-CCMDNSSuffix { <# .SYNOPSIS Sets the current DNS suffix for the MEMCM Client .DESCRIPTION This function will set the current DNS suffix for the MEMCM Client. This is done using the Microsoft.SMS.Client COM Object. .PARAMETER DNSSuffix The desired DNS Suffix that will be set for the specified computers/cimsessions .PARAMETER CimSession Provides CimSessions to set the current DNS suffix for .PARAMETER ComputerName Provides computer names to set the current DNS suffix for .PARAMETER PSSession Provides PSSession to set the current DNS suffix for .PARAMETER ConnectionPreference Determines if the 'Get-CCMConnection' function should check for a PSSession, or a CIMSession first when a ComputerName is passed to the function. This is ultimately going to result in the function running faster. The typical use case is when you are using the pipeline. In the pipeline scenario, the 'ComputerName' parameter is what is passed along the pipeline. The 'Get-CCMConnection' function is used to find the available connections, falling back from the preference specified in this parameter, to the the alternative (eg. you specify, PSSession, it falls back to CIMSession), and then falling back to ComputerName. Keep in mind that the 'ConnectionPreference' also determines what type of connection / command the ComputerName parameter is passed to. .EXAMPLE C:\PS> Set-CCMDNSSuffix -DNSSuffix 'contoso.com' Sets the local computer's DNS Suffix to contoso.com .EXAMPLE C:\PS> Set-CCMDNSSuffix -ComputerName 'Workstation1234','Workstation4321' -DNSSuffix 'contoso.com' Sets the DNS Suffix for Workstation1234, and Workstation4321 to contoso.com .NOTES FileName: Set-CCMDNSSuffix.ps1 Author: Cody Mathis Contact: @CodyMathis123 Created: 2020-01-18 Updated: 2020-03-01 #> [CmdletBinding(SupportsShouldProcess = $true, DefaultParameterSetName = 'ComputerName')] param( [parameter(Mandatory = $false)] [string]$DNSSuffix, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'CimSession')] [Microsoft.Management.Infrastructure.CimSession[]]$CimSession, [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ComputerName')] [Alias('Connection', 'PSComputerName', 'PSConnectionName', 'IPAddress', 'ServerName', 'HostName', 'DNSHostName')] [string[]]$ComputerName = $env:ComputerName, [Parameter(Mandatory = $false, ParameterSetName = 'PSSession')] [Alias('Session')] [System.Management.Automation.Runspaces.PSSession[]]$PSSession, [Parameter(Mandatory = $false, ParameterSetName = 'ComputerName')] [ValidateSet('CimSession', 'PSSession')] [string]$ConnectionPreference ) begin { $SetDNSSuffixScriptBlockString = [string]::Format('(New-Object -ComObject Microsoft.SMS.Client).SetDNSSuffix("{0}")', $DNSSuffix) $SetDNSSuffixScriptBlock = [scriptblock]::Create($SetDNSSuffixScriptBlockString) $invokeCommandSplat = @{ ScriptBlock = $SetDNSSuffixScriptBlock } } process { foreach ($Connection in (Get-Variable -Name $PSCmdlet.ParameterSetName -ValueOnly)) { $getConnectionInfoSplat = @{ $PSCmdlet.ParameterSetName = $Connection } switch ($PSBoundParameters.ContainsKey('ConnectionPreference')) { $true { $getConnectionInfoSplat['Prefer'] = $ConnectionPreference } } $ConnectionInfo = Get-CCMConnection @getConnectionInfoSplat $Computer = $ConnectionInfo.ComputerName $connectionSplat = $ConnectionInfo.connectionSplat $Result = [ordered]@{ } $Result['ComputerName'] = $Computer if ($PSCmdlet.ShouldProcess("[ComputerName = '$Computer'] [DNSSuffix = '$DNSSuffix']", "Set-CCMDNSSuffix")) { try { switch ($Computer -eq $env:ComputerName) { $true { $SetDNSSuffixScriptBlock.Invoke() } $false { Invoke-CCMCommand @invokeCommandSplat @connectionSplat } } $Result['DNSSuffixSet'] = $true } catch { $Result['DNSSuffixSet'] = $false Write-Error "Failure to set DNS Suffix to $DNSSuffix for $Computer - $($_.Exception.Message)" } [pscustomobject]$Result } } } } |