Start-TssDirectoryServiceSync - new command

thycotic-ps · Sep 10, 2021 · fb4edce · fb4edce
1 parent 0a8dd94
commit fb4edce
Show file tree

Hide file tree

Showing 5 changed files with 236 additions and 6 deletions.
diff --git a/docs/commands/directory-services/Get-TssDirectoryServiceSyncStatus.md b/docs/commands/directory-services/Get-TssDirectoryServiceSyncStatus.md
@@ -0,0 +1,58 @@
+# Get-TssDirectoryServiceSyncStatus
+
+## SYNOPSIS
+Get status of the Directory Services synchronization
+
+## SYNTAX
+
+```
+Get-TssDirectoryServiceSyncStatus [-TssSession] <Session> [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get status of the Directory Services synchronization
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Get-TssDirectoryServiceSyncStatus -TssSession $session
+```
+
+Return status of the directory service synchronization
+
+## 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
+```
+
+### 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
+
+### Thycotic.PowerShell.DirectoryServices.SyncStatus
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/directory-services/Get-TssDirectoryServiceSyncStatus](https://thycotic-ps.github.io/thycotic.secretserver/commands/directory-services/Get-TssDirectoryServiceSyncStatus)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/directory-services/Get-TssDirectoryServiceSyncStatus.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/directory-services/Get-TssDirectoryServiceSyncStatus.ps1)
+
diff --git a/docs/commands/directory-services/Start-TssDirectoryServiceSync.md b/docs/commands/directory-services/Start-TssDirectoryServiceSync.md
@@ -0,0 +1,88 @@
+# Start-TssDirectoryServiceSync
+
+## SYNOPSIS
+Run synchronization to update users and groups for all enabled Directories
+
+## SYNTAX
+
+```
+Start-TssDirectoryServiceSync [-TssSession] <Session> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Run synchronization to update users and groups for all enabled Directories
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+Start-TssDirectoryServiceSync -TssSession $session
+```
+
+Run Directory Services synchronization
+
+## 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
+```
+
+### -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/active-directory/Start-TssDirectoryServiceSync](https://thycotic-ps.github.io/thycotic.secretserver/commands/active-directory/Start-TssDirectoryServiceSync)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/active-directory/Start-TssDirectoryServiceSync.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/active-directory/Start-TssDirectoryServiceSync.ps1)
+
diff --git a/docs/commands/folders/New-TssFolder.md b/docs/commands/folders/New-TssFolder.md
@@ -18,25 +18,29 @@ Create a new folder
 ### EXAMPLE 1
 ```
 $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
-$folderStub = Get-TssFolderStub -TssSession $session
-New-TssFolder -TssSession $session -FolderStub $folderStub -FolderName 'tssNewFolder' -ParentFolderId -1
+New-TssFolder -TssSession $session -FolderName 'tssNewFolder'
 ```
 
-Creates a folder named "tssNewFolder" at the root of Secret Server application
+Creates a root folder named "tssNewFolder"
 
 ### EXAMPLE 2
 ```
 $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
-$folderStub = Get-TssFolderStub -TssSession $session
-New-TssFolder -TssSession $session -FolderStub $folderStub -FolderName 'IT Dept' -ParentFolderId 27 -InheritPermissions:$false
+$folderParams = @{
+    TssSession = $session
+    FolderName 'IT Dept'
+    ParentFolderId = 27
+    InheritPermissions = $false
+}
+New-TssFolder @folderParams
 ```
 
 Creates a folder named "IT Dept" under parent folder 27 with Inherit Permissins disabled (set to No if viewed in the UI)
 
 ### EXAMPLE 3
 ```
 $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
-Get-TssFolderStub -TssSession $session | New-TssFolder -TssSession $session -FolderName 'Marketing Dept' -ParentFolderId 27 -InheritPermissions -InheritSecretPolicy
+New-TssFolder -TssSession $session -FolderName 'Marketing Dept' -ParentFolderId 27 -InheritPermissions -InheritSecretPolicy
 ```
 
 Creates a folder named "Marketing Dept" under parent folder 27 with inheritance enabled for Permissions and Secret Policy

diff --git a/src/functions/directory-services/Start-TssDirectoryServiceSync.ps1 b/src/functions/directory-services/Start-TssDirectoryServiceSync.ps1
@@ -0,0 +1,61 @@
+function Start-TssDirectoryServiceSync {
+    <#
+    .SYNOPSIS
+    Run synchronization to update users and groups for all enabled Directories
+
+    .DESCRIPTION
+    Run synchronization to update users and groups for all enabled Directories
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Start-TssDirectoryServiceSync -TssSession $session
+
+    Run Directory Services synchronization
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/active-directory/Start-TssDirectoryServiceSync
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/active-directory/Start-TssDirectoryServiceSync.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
+    )
+    begin {
+        $tssParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeApiParams $TssSession
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
+            $uri = $TssSession.ApiUrl, 'directory-services', 'synchronization-now' -join '/'
+            $invokeParams.Uri = $uri
+            $invokeParams.Method = 'POST'
+
+            $invokeParams.Body = $discoverBody | ConvertTo-Json
+            if (-not $PSCmdlet.ShouldProcess("Directory Sync", "$($invokeParams.Method) $uri")) { return }
+            Write-Verbose "Performing the operation: $($invokeParams.Method) $uri"
+            try {
+                $apiResponse = Invoke-TssApi @invokeParams
+                $restResponse = . $ProcessResponse $apiResponse
+            } catch {
+                $err = $_
+                . $ErrorHandling $err
+            }
+
+            if ($restResponse) {
+                Write-Verbose "Directory Service sync successfully started"
+            }
+        } else {
+            Write-Warning 'No valid session found'
+        }
+    }
+}
diff --git a/tests/directory-services/Start-TssDirectoryServiceSync.Tests.ps1 b/tests/directory-services/Start-TssDirectoryServiceSync.Tests.ps1
@@ -0,0 +1,19 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession'
+        [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
+        }
+    }
+}