ansible_collections/lowlydba/sqlserver/plugins/modules/tcp_port.ps1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

#!powershell
# -*- coding: utf-8 -*-

# (c) 2022, John McCall (@lowlydba)
# (c) 2021, Sudhir Koduri (@kodurisudhir)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

#AnsibleRequires -CSharpUtil Ansible.Basic
#AnsibleRequires -PowerShell ansible_collections.lowlydba.sqlserver.plugins.module_utils._SqlServerUtils
#Requires -Modules @{ ModuleName="dbatools"; ModuleVersion="2.0.0" }

$ErrorActionPreference = "Stop"

# Get Csharp utility module
$spec = @{
    supports_check_mode = $true
    options = @{
        username = @{type = 'str'; required = $false }
        password = @{type = 'str'; required = $false; no_log = $true }
        port = @{type = 'int'; required = $true }
        ip_address = @{type = 'str'; required = $false }
        force = @{type = 'bool'; required = $false; default = $false }
    }
    required_together = @(
        , @('username', 'password')
    )
}

$module = [Ansible.Basic.AnsibleModule]::Create($args, $spec, @(Get-LowlyDbaSqlServerAuthSpec))
$sqlInstance, $sqlCredential = Get-SqlCredential -Module $module
if ($null -ne $module.Params.username) {
    [securestring]$secPassword = ConvertTo-SecureString $Module.Params.password -AsPlainText -Force
    [pscredential]$credential = New-Object System.Management.Automation.PSCredential ($Module.Params.username, $secPassword)
}
$port = $module.Params.port
$ipAddress = $module.Params.ip_address
$checkMode = $module.CheckMode
$force = $module.Params.force
$module.Result.changed = $false
$PSDefaultParameterValues = @{ "*:EnableException" = $true; "*:Confirm" = $false; "*:WhatIf" = $checkMode }

try {
    $tcpPortSplat = @{
        SqlInstance = $SqlInstance
        Credential = $credential
        Port = $port
        Force = $force
    }
    if ($ipAddress) {
        $tcpPortSplat.Add("IPAddress", $ipAddress)
    }
    $output = Set-DbaTcpPort @tcpPortSplat

    if ($output.Changes.Count -gt 0 -or $checkMode) {
        $module.Result.changed = $true
        if ($force -ne $true) {
            $output | Add-Member -MemberType NoteProperty -Name "RestartRequired" -Value $true
        }
    }

    if ($null -ne $output) {
        $resultData = ConvertTo-SerializableObject -InputObject $output
        $module.Result.data = $resultData
    }
    $module.ExitJson()
}
catch {
    $module.FailJson("Configuring TCP port failed: $($_.Exception.Message)", $_)
}