HeartbeatStatus enum - adjust params and property to use enumerator

thycotic-ps · Oct 26, 2021 · 45f3fb4 · 45f3fb4
1 parent d090d7d
commit 45f3fb4
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 19 deletions.
diff --git a/docs/commands/secrets/Find-TssSecret.md b/docs/commands/secrets/Find-TssSecret.md
@@ -9,15 +9,16 @@ Find a secret
 ```
 Find-TssSecret [-TssSession] <Session> [-Id <Int32>] [-FolderId <Int32>] [-IncludeSubFolders] [-Field <String>]
  [-FieldText <String>] [-ExactMatch] [-FieldSlug <String>] [-ExtendedField <String[]>]
- [-ExtendedTypeId <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>] [-HeartbeatStatus <String>]
- [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe] [-PasswordTypeIds <Int32[]>]
- [-Permission <String>] [-Scope <String>] [-ExcludeDoubleLock] [-DoubleLockId <Int32>] [<CommonParameters>]
+ [-ExtendedTypeId <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>]
+ [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
+ [-PasswordTypeIds <Int32[]>] [-Permission <String>] [-Scope <String>] [-ExcludeDoubleLock]
+ [-DoubleLockId <Int32>] [<CommonParameters>]
 ```
 
 ### secret
 ```
 Find-TssSecret [-TssSession] <Session> [-Id <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>]
- [-HeartbeatStatus <String>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
+ [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
  [-PasswordTypeIds <Int32[]>] [-ExcludeDoubleLock] [-DoubleLockId <Int32>] [<CommonParameters>]
 ```
 
@@ -233,9 +234,10 @@ Accept wildcard characters: False
 Return only secrets with a certain heartbeat status
 
 ```yaml
-Type: String
+Type: SecretHeartbeatStatus
 Parameter Sets: filter, secret
 Aliases:
+Accepted values: Failed, Success, Pending, Disabled, UnableToConnect, UnknownError, IncompatibleHost, AccountLockedOut, DnsMismatch, UnableToValidateServerPublicKey, Processing, ArgumentError, AccessDenied
 
 Required: False
 Position: Named

diff --git a/docs/commands/secrets/Search-TssSecret.md b/docs/commands/secrets/Search-TssSecret.md
@@ -9,10 +9,10 @@ Search for a secret
 ```
 Search-TssSecret [-TssSession] <Session> [-FolderId <Int32>] [-IncludeSubFolders] [-Field <String>]
  [-SearchText <String>] [-ExactMatch] [-FieldSlug <String>] [-ExtendedField <String[]>]
- [-ExtendedTypeId <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>] [-HeartbeatStatus <String>]
- [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe] [-PasswordTypeIds <Int32[]>]
- [-Permission <String>] [-Scope <String>] [-ExcludeDoubleLock] [-DoubleLockId <Int32>] [-SortBy <String>]
- [<CommonParameters>]
+ [-ExtendedTypeId <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>]
+ [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
+ [-PasswordTypeIds <Int32[]>] [-Permission <String>] [-Scope <String>] [-ExcludeDoubleLock]
+ [-DoubleLockId <Int32>] [-SortBy <String>] [<CommonParameters>]
 ```
 
 ### folder
@@ -31,7 +31,7 @@ Search-TssSecret [-TssSession] <Session> [-Field <String>] [-SearchText <String>
 ### secret
 ```
 Search-TssSecret [-TssSession] <Session> [-SecretTemplateId <Int32>] [-SiteId <Int32>]
- [-HeartbeatStatus <String>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
+ [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
  [-PasswordTypeIds <Int32[]>] [-ExcludeDoubleLock] [-DoubleLockId <Int32>] [-SortBy <String>]
  [<CommonParameters>]
 ```
@@ -262,9 +262,10 @@ Accept wildcard characters: False
 Return only secrets with a certain heartbeat status
 
 ```yaml
-Type: String
+Type: SecretHeartbeatStatus
 Parameter Sets: filter, secret
 Aliases:
+Accepted values: Failed, Success, Pending, Disabled, UnableToConnect, UnknownError, IncompatibleHost, AccountLockedOut, DnsMismatch, UnableToValidateServerPublicKey, Processing, ArgumentError, AccessDenied
 
 Required: False
 Position: Named

diff --git a/src/Thycotic.SecretServer/classes/secrets/HeartbeatStatus.cs b/src/Thycotic.SecretServer/classes/secrets/HeartbeatStatus.cs
@@ -2,12 +2,13 @@
 using System.Threading.Tasks;
 using System.Management.Automation;
 using System.Management.Automation.Runspaces;
+using Thycotic.PowerShell.Enums;
 
 namespace Thycotic.PowerShell.Secrets
 {
     public class HeartbeatStatus
     {
-        public string Status { get; set; }
+        public HeartbeatStatus Status { get; set; }
         public DateTime? LastHeartbeatCheck { get; set; }
     }
 }
diff --git a/src/Thycotic.SecretServer/classes/secrets/Secret.cs b/src/Thycotic.SecretServer/classes/secrets/Secret.cs
@@ -4,6 +4,7 @@
 using System.Threading.Tasks;
 using System.Management.Automation;
 using System.Management.Automation.Runspaces;
+using Thycotic.PowerShell.Enums;
 
 namespace Thycotic.PowerShell.Secrets
 {
@@ -32,7 +33,7 @@ public class Secret
         public bool IsRestricted { get; set; }
         public Items[] Items { get; set; }
         public DateTime? LastHeartBeatCheck { get; set; }
-        public string LastHeartBeatStatus { get; set; }
+        public HeartbeatStatus LastHeartBeatStatus { get; set; }
         public DateTime? LastPasswordChangeAttempt { get; set; }
         public int LauncherConnectAsSecretId { get; set; }
         public string Name { get; set; }

diff --git a/src/Thycotic.SecretServer/classes/secrets/Summary.cs b/src/Thycotic.SecretServer/classes/secrets/Summary.cs
@@ -2,6 +2,7 @@
 using System.Threading.Tasks;
 using System.Management.Automation;
 using System.Management.Automation.Runspaces;
+using Thycotic.PowerShell.Enums;
 
 namespace Thycotic.PowerShell.Secrets
 {
@@ -23,7 +24,7 @@ public class Summary
         public string OutOfSyncReason { get; set; }
         public bool IsRestricted { get; set; }
         public DateTime? LastAccessed { get; set; }
-        public string LastHeartbeatStatus { get; set; }
+        public SecretHeartbeatStatus LastHeartbeatStatus { get; set; }
         public DateTime? LastPasswordChangeAttempt { get; set; }
         public string Name { get; set; }
         public bool RequiresApproval { get; set; }

diff --git a/src/Thycotic.SecretServer/enums/secrets/HeartbeatStatus.cs b/src/Thycotic.SecretServer/enums/secrets/HeartbeatStatus.cs
@@ -0,0 +1,24 @@
+using System;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace Thycotic.PowerShell.Enums
+{
+    public enum SecretHeartbeatStatus
+    {
+        Failed = 0,
+        Success = 1,
+        Pending = 2,
+        Disabled = 3,
+        UnableToConnect = 4,
+        UnknownError = 5,
+        IncompatibleHost = 6,
+        AccountLockedOut = 7,
+        DnsMismatch = 8,
+        UnableToValidateServerPublicKey = 9,
+        Processing = 10,
+        ArgumentError = 11,
+        AccessDenied = 12
+    }
+}
diff --git a/src/functions/rpc/Get-TssRpcAssociatedSecret.ps1 b/src/functions/rpc/Get-TssRpcAssociatedSecret.ps1
@@ -39,7 +39,6 @@ function Get-TssRpcAssociatedSecret {
         $tssParams = $PSBoundParameters
         $invokeParams = . $GetInvokeApiParams $TssSession
     }
-
     process {
         Write-TssInternalNote $PSCmdlet.MyInvocation
         Get-TssInvocation $PSCmdlet.MyInvocation

diff --git a/src/functions/secrets/Find-TssSecret.ps1 b/src/functions/secrets/Find-TssSecret.ps1
@@ -104,8 +104,7 @@ function Find-TssSecret {
         # Return only secrets with a certain heartbeat status
         [Parameter(ParameterSetName = 'filter')]
         [Parameter(ParameterSetName = 'secret')]
-        [ValidateSet('Failed', 'Success', 'Pending', 'Disabled', 'UnableToConnect', 'UnknownError', 'IncompatibleHost', 'AccountLockedOut', 'DnsMismatch', 'UnableToValidateServerPublicKey', 'Processing', 'ArgumentError', 'AccessDenied')]
-        [string]
+        [Thycotic.PowerShell.Enums.SecretHeartbeatStatus]
         $HeartbeatStatus,
 
         # Include inactive/disabled secrets
@@ -193,6 +192,9 @@ function Find-TssSecret {
                     'ExactMatch' {
                         $filters += "filter.isExactmatch=$($tssParams['ExactMatch'])"
                     }
+                    'HeartbeatStatus' {
+                        $filters += "filter.heartbeatStatus=$([string]$HeartbeatStatus)"
+                    }
                     'ExtendedField' {
                         foreach ($v in $tssParams['ExtendedField']) {
                             $filters += "filter.extendedField=$v"

diff --git a/src/functions/secrets/Search-TssSecret.ps1 b/src/functions/secrets/Search-TssSecret.ps1
@@ -128,8 +128,7 @@ function Search-TssSecret {
         # Return only secrets with a certain heartbeat status
         [Parameter(ParameterSetName = 'filter')]
         [Parameter(ParameterSetName = 'secret')]
-        [ValidateSet('Failed', 'Success', 'Pending', 'Disabled', 'UnableToConnect', 'UnknownError', 'IncompatibleHost', 'AccountLockedOut', 'DnsMismatch', 'UnableToValidateServerPublicKey', 'Processing', 'ArgumentError', 'AccessDenied')]
-        [string]
+        [Thycotic.PowerShell.Enums.SecretHeartbeatStatus]
         $HeartbeatStatus,
 
         # Include inactive/disabled secrets
@@ -214,6 +213,9 @@ function Search-TssSecret {
                 'SearchText' {
                     $filters += "filter.searchText=$($tssParams['SearchText'])"
                 }
+                'HeartbeatStatus' {
+                    $filters += "filter.heartbeatStatus=$([string]$HeartbeatStatus)"
+                }
                 'ExactMatch' {
                     $filters += "filter.isExactmatch=$($tssParams['ExactMatch'])"
                 }