DistributedEngines - class conversion

thycotic-ps · Jul 25, 2021 · 962a5e5 · 962a5e5
1 parent bc8490e
commit 962a5e5
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 55 deletions.
diff --git a/...stributed-engines/about_tsssitemetrics.md → ...topics/distributed-engines/SiteMetrics.md b/...stributed-engines/about_tsssitemetrics.md → ...topics/distributed-engines/SiteMetrics.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSiteSummary"
+title: "SiteMetrics"
 ---
 
 # TOPIC
-    This help topic describes the TssSiteMetric class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.DistributedEngines.SiteMetrics class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSiteMetric
+    Thycotic.PowerShell.DistributedEngines.SiteMetrics
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSiteMetric class represents the SiteMetic object returned by Secret Server endpoint GET /distributed-engines/sites
+    The Thycotic.PowerShell.DistributedEngines.SiteMetrics class represents the SiteMetic object returned by Secret Server endpoint GET /distributed-engines/sites
     List of Metrics for this site such as ConnectionStatusOffline, ConnectionStatusOnline, ActivationStatusPending, LostConnection, and more. Only returned on a search when IncludeSiteMetrics is true.
 
 # CONSTRUCTORS
@@ -31,5 +31,4 @@ title: "TssSiteSummary"
 # METHODS
 
 # RELATED LINKS:
-    TssSiteSummary
     Search-TssDistributedEngineSite
diff --git a/...stributed-engines/about_tsssitesummary.md → ...topics/distributed-engines/SiteSummary.md b/...stributed-engines/about_tsssitesummary.md → ...topics/distributed-engines/SiteSummary.md
@@ -1,18 +1,18 @@
 ---
-title: "TssSiteSummary"
+title: "SiteSummary"
 ---
 
 # TOPIC
-    This help topic describes the TssSiteSummary class in the Thycotic.SecretServer module
+    This help topic describes the Thycotic.PowerShell.DistributedEngines.SiteSummary class in the Thycotic.SecretServer module
 
 # CLASS
-    TssSiteSummary
+    Thycotic.PowerShell.DistributedEngines.SiteSummary
 
 # INHERITANCE
     None
 
 # DESCRIPTION
-    The TssSiteSummary class represents the SiteSummaryModel object returned by Secret Server endpoint GET /distributed-engines/sites
+    The Thycotic.PowerShell.DistributedEngines.SiteSummary class represents the SiteSummaryModel object returned by Secret Server endpoint GET /distributed-engines/sites
 
 # CONSTRUCTORS
     new()
@@ -39,7 +39,7 @@ title: "TssSiteSummary"
     SiteId: integer (int32)
         Id of Site
 
-    SiteMetrics: [TssSiteMetric[]]
+    SiteMetrics: SiteMetric[]
         List of Metrics for this site such as ConnectionStatusOffline, ConnectionStatusOnline, ActivationStatusPending, LostConnection, and more. Only returned on a search when IncludeSiteMetrics is true.
 
     SiteName: string

diff --git a/docs/about_topics/distributed-engines/readme.md b/docs/about_topics/distributed-engines/readme.md
@@ -1,3 +1,3 @@
-# Distributed Engines
+# Thycotic.PowerShell.DistributedEngines
 
 {% include list.liquid all=true %}
diff --git a/docs/commands/directory-services/Search-TssDirectoryServiceDomain.md b/docs/commands/directory-services/Search-TssDirectoryServiceDomain.md
@@ -92,7 +92,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssDomainSummary
+### Thycotic.PowerShell.DirectoryServices.DomainSummary
 ## NOTES
 Requires TssSession object returned by New-TssSession
 

diff --git a/docs/commands/distributed-engines/Search-TssDistributedEngineSite.md b/docs/commands/distributed-engines/Search-TssDistributedEngineSite.md
@@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
-### TssSiteSummary
+### Thycotic.PowerShell.DistributedEngines.SiteSummary
 ## NOTES
 Requires TssSession object returned by New-TssSession
 

diff --git a/src/Thycotic.SecretServer/classes/distributed-engines/SiteMetrics.cs b/src/Thycotic.SecretServer/classes/distributed-engines/SiteMetrics.cs
@@ -0,0 +1,14 @@
+using System;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace Thycotic.PowerShell.DistributedEngines
+{
+    public class SiteMetrics
+    {
+        public string MetricDisplayName { get; set; }
+        public string MetricName { get; set; }
+        public int MetricValue { get; set; }
+    }
+}
diff --git a/src/Thycotic.SecretServer/classes/distributed-engines/SiteSummary.cs b/src/Thycotic.SecretServer/classes/distributed-engines/SiteSummary.cs
@@ -0,0 +1,20 @@
+using System;
+using System.Threading.Tasks;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace Thycotic.PowerShell.DistributedEngines
+{
+    public class SiteSummary
+    {
+        public bool Active { get; set; }
+        public bool IsLocal { get; set; }
+        public DateTime? LastActivity { get; set; }
+        public int NumEnginesMissingNetFramework { get; set; }
+        public int OfflineEngineCount { get; set; }
+        public int OnlineEngineCount { get; set; }
+        public int SiteId { get; set; }
+        public SiteMetrics[] SiteMetrics { get; set; }
+        public string SiteName { get; set; }
+    }
+}
diff --git a/src/classes/distributed-engines/TssSiteSummary.class.ps1 b/src/classes/distributed-engines/TssSiteSummary.class.ps1
diff --git a/src/classes/distributed-engines/dependencies/TssSiteMetrics.class.ps1 b/src/classes/distributed-engines/dependencies/TssSiteMetrics.class.ps1
diff --git a/src/functions/distributed-engines/Search-DistributedEngineSite.ps1 b/src/functions/distributed-engines/Search-DistributedEngineSite.ps1
@@ -22,7 +22,7 @@ function Search-DistributedEngineSite {
     Requires TssSession object returned by New-TssSession
     #>
     [CmdletBinding()]
-    [OutputType('TssSiteSummary')]
+    [OutputType('Thycotic.PowerShell.DistributedEngines.SiteSummary')]
     param (
         # TssSession object created by New-TssSession for authentication
         [Parameter(Mandatory, ValueFromPipeline, Position = 0)]
@@ -102,7 +102,7 @@ function Search-DistributedEngineSite {
                 Write-Warning 'No Distributed Engine Sites found'
             }
             if ($restResponse.records) {
-                [TssSiteSummary[]]$restResponse.records
+                [Thycotic.PowerShell.DistributedEngines.SiteSummary[]]$restResponse.records
             }
         } else {
             Write-Warning 'No valid session found'

diff --git a/tests/distributed-engines/Search-DistributedEngineSite.Tests.ps1 b/tests/distributed-engines/Search-DistributedEngineSite.Tests.ps1
@@ -18,8 +18,8 @@ Describe "$commandName verify parameters" {
         }
     }
     Context "Command specific details" {
-        It "$commandName should set OutputType to TssSiteSummary" -TestCases $commandDetails {
-            $_.OutputType.Name | Should -Be 'TssSiteSummary'
+        It "$commandName should set OutputType to Thycotic.PowerShell.DistributedEngines.SiteSummary" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.DistributedEngines.SiteSummary'
         }
     }
 }