Set-TssIpRestrictionGroup - new command to set the IP Restriction for…

… a Group(s)
thycotic-ps · Oct 1, 2021 · 6e40023 · 6e40023
1 parent e020c6d
commit 6e40023
Show file tree

Hide file tree

Showing 3 changed files with 247 additions and 0 deletions.
diff --git a/docs/commands/ipaddress-restrictions/Set-TssIpRestrictionGroup.md b/docs/commands/ipaddress-restrictions/Set-TssIpRestrictionGroup.md
@@ -0,0 +1,135 @@
+# Set-TssIpRestrictionGroup
+
+## SYNOPSIS
+Set IP Address Restriction(s) for a group(s)
+
+## SYNTAX
+
+```
+Set-TssIpRestrictionGroup [-TssSession] <Session> -Id <Int32[]> -GroupId <Int32[]> [-WhatIf] [-Confirm]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Set IP Address Restriction(s) for a group(s)
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Set-TssIpRestrictionGroup -TssSession session -Id 42 -GroupId 14
+```
+
+Set IP Restriction 42 on Group 14
+
+### EXAMPLE 2
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Set-TssIpRestrictionGroup -TssSession session -Id 65, 43, 13 -GroupId 97, 463, 109
+```
+
+Set each IP Restriction provided on each Group provided
+
+### EXAMPLE 3
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Set-TssIpRestrictionGroup -TssSession session -Id 65, 43, 13 -GroupId 97, 463, 109 -WhatIf
+```
+
+Outputs verbose messages of action to be performed
+
+## PARAMETERS
+
+### -TssSession
+TssSession object created by New-TssSession for authentication
+
+```yaml
+Type: Session
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Id
+IP Address Restriction ID(s)
+
+```yaml
+Type: Int32[]
+Parameter Sets: (All)
+Aliases: IpAddressRestrictionId
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -GroupId
+Group ID(s)
+
+```yaml
+Type: Int32[]
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Set-TssIpRestrictionGroup](https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Set-TssIpRestrictionGroup)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Set-TssIpRestrictionGroup.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Set-TssIpRestrictionGroup.ps1)
+
diff --git a/src/functions/ipaddress-restrictions/Set-TssIpRestrictionGroup.ps1 b/src/functions/ipaddress-restrictions/Set-TssIpRestrictionGroup.ps1
@@ -0,0 +1,93 @@
+function Set-TssIpRestrictionGroup {
+    <#
+    .SYNOPSIS
+    Set IP Address Restriction(s) for a group(s)
+
+    .DESCRIPTION
+    Set IP Address Restriction(s) for a group(s)
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Set-TssIpRestrictionGroup -TssSession session -Id 42 -GroupId 14
+
+    Set IP Restriction 42 on Group 14
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Set-TssIpRestrictionGroup -TssSession session -Id 65, 43, 13 -GroupId 97, 463, 109
+
+    Set each IP Restriction provided on each Group provided
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Set-TssIpRestrictionGroup -TssSession session -Id 65, 43, 13 -GroupId 97, 463, 109 -WhatIf
+
+    Outputs verbose messages of action to be performed
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/ipaddress-restrictions/Set-TssIpRestrictionGroup
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/ipaddress-restrictions/Set-TssIpRestrictionGroup.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [cmdletbinding(SupportsShouldProcess)]
+    param(
+        # TssSession object created by New-TssSession for authentication
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [Thycotic.PowerShell.Authentication.Session]
+        $TssSession,
+
+        # IP Address Restriction ID(s)
+        [Parameter(Mandatory, ValueFromPipelineByPropertyName)]
+        [Alias('IpAddressRestrictionId')]
+        [int[]]
+        $Id,
+
+        # Group ID(s)
+        [Parameter(Mandatory)]
+        [int[]]
+        $GroupId
+    )
+    begin {
+        $setParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeApiParams $TssSession
+    }
+    process {
+        Get-TssInvocation $PSCmdlet.MyInvocation
+        if ($setParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            Compare-TssVersion $TssSession '10.9.000064' $PSCmdlet.MyInvocation
+            foreach ($group in $GroupId) {
+                foreach ($restriction in $Id) {
+                    $uri = $TssSession.ApiUrl, 'ipaddress-restrictions', $restriction, 'groups' -join '/'
+                    $invokeParams.Uri = $uri
+                    $invokeParams.Method = 'POST'
+
+                    $setBody = @{
+                        GroupId                = $group
+                        IpAddressRestrictionId = $restriction
+                    }
+                    $invokeParams.Body = $setBody | ConvertTo-Json
+                    if ($PSCmdlet.ShouldProcess("IP Restriction: $restriction", "$($invokeParams.Method) $($invokeParams.Uri) with:`n$($invokeParams.Body)`n")) {
+                        Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri) with:`n$($invokeParams.Body)`n"
+                        try {
+                            $apiResponse = Invoke-TssApi @invokeParams
+                            $restResponse = . $ProcessResponse $apiResponse
+                        } catch {
+                            Write-Warning "Issue setting IP Restriction [$restriction] on Group [$group]"
+                            $err = $_
+                            . $ErrorHandling $err
+                        }
+                    }
+                    if ($restResponse.groupId -eq $group) {
+                        Write-Verbose 'Group [$group] assigned to IP Restriction [$restriction]'
+                    }
+                }
+            }
+        } else {
+            Write-Warning 'No valid session found'
+        }
+    }
+}
diff --git a/tests/ipaddress-restrictions/Set-TssIpRestrictionGroup.Tests.ps1 b/tests/ipaddress-restrictions/Set-TssIpRestrictionGroup.Tests.ps1
@@ -0,0 +1,19 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'Id', 'GroupId'
+        [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys
+        [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')
+        $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru
+    }
+    Context "Verify parameters" -Foreach @{currentParams = $currentParams } {
+        It "$commandName should contain <_> parameter" -TestCases $knownParameters {
+            $_ -in $currentParams | Should -Be $true
+        }
+        It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters {
+            $_ | Should -BeNullOrEmpty
+        }
+    }
+}