Get-TssConfiguration - fixes #148

April release adds additional properties

docs/_data/navigation.yml

@@ -201,10 +201,14 @@ abouttopics:
         url: /abouttopics/about_tssconfigurationgeneral
       - title: "TssConfigurationFolders"
         url: /abouttopics/about_tssconfigurationfolders
+      - title: "TssConfigurationLauncherSettings"
+        url: /abouttopics/about_tssconfigurationlaunchersettings
       - title: "TssConfigurationLocalUserPasswords"
         url: /abouttopics/about_tssconfigurationlocaluserpasswords
       - title: "TssConfigurationPermissionOptions"
         url: /abouttopics/about_tssconfigurationpermissionoptions
+      - title: "TssConfigurationProtocolHandlerSettings"
+        url: /abouttopics/about_tssconfigurationpermissionoptions
       - title: "TssConfigurationUserExperience"
         url: /abouttopics/about_tssconfigurationuserexperience
       - title: "TssConfigurationUserInterface"

docs/collections/_abouttopics/about_tssconfigurationapplicationsettings.md

@@ -20,77 +20,83 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     new()
 
 # PROPERTIES
-    AllowSendTelemetry
+    AllowSendTelemetry: boolean
         Send Anonymized System Metrics Information
 
-    AllowSoftwareUpdateChecks
-        Allow software update checks
+    AllowSoftwareUpdateChecks: boolean
+        Allow software update checks. This setting is ignored in cloud environments.
 
-    ApiRefreshTokensEnabled
+    ApiRefreshTokensEnabled: boolean
         API Refresh Tokens Enabled
 
-    ApiSessionTimeoutDays
+    ApiSessionTimeoutDays: integer (int32)
         API session timeout days
 
-    ApiSessionTimeoutHours
+    ApiSessionTimeoutHours: integer (int32)
         API session timeout hours
 
-    ApiSessionTimeoutMinutes
+    ApiSessionTimeoutMinutes: integer (int32)
         API session timeout minutes
 
-    ApiSessionTimeoutUnlimited
+    ApiSessionTimeoutUnlimited: boolean
         API session timeout unlimited
 
-    CustomUrl
-        Outward accessible url to get to application
+    ConfigurationEarlyAdopterEnabled: boolean
+        Notify when preview releases are available. False by default
 
-    EnableCredSsp
+    CustomUrl: string
+        Outward accessible url to get to application. This setting is ignored in cloud environments.
+
+    DisplayDowntimeMessageToAdminsOnly: boolean
+        Display Downtime Message To Admins Only
+
+    EnableCredSsp: boolean
         Enable Cred SSP for win RM
 
-    EnableSyslogCefLogging
+    EnableSyslogCefLogging: boolean
         Enable Syslog/CEF Logging
 
-    EnableWebServices
+    EnableWebServices: boolean
         Enable Web services
 
-    MaximumTokenRefreshesAllowed
+    MaximumTokenRefreshesAllowed: integer (int32)
         Maximum Token Refreshes Allowed
 
-    MaxSecretLogLength
+    MaxSecretLogLength: integer (int32)
         Maximum number of entries in secret log
 
-    MobileMaxOfflineDays
+    MobileMaxOfflineDays: integer (int32)
         The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device
 
-    MobileMaxOfflineHours
+    MobileMaxOfflineHours: integer (int32)
         The Maximum Time for Offline Access on Mobile Devices setting in Secret Server determines how long to cache secret data on the mobile device
 
-    PreventApplicationFromSleeping
-        A keep alive thread will run in the background pinging the web URL to make sure IIS does not stop running due to inactivity
+    PreventApplicationFromSleeping: boolean
+        A keep alive thread will run in the background pinging the web URL to make sure IIS does not stop running due to inactivity. This setting is ignored in cloud environments.
 
-    SyslogCefLogSite
+    SyslogCefLogSite: integer (int32)
         This is the site that the CEF/Syslogs will run on
 
-    SyslogCefPort
+    SyslogCefPort: integer (int32)
         Syslog/CEF Protocol
 
-    SyslogCefProtocol
-        Syslog/CEF Protocol to use when sending logs (UPD, TCP, SECURE_TCP)
+    SyslogCefProtocol: string
+        Syslog/CEF Protocol to use when sending logs
 
-    SyslogCefServer
+    SyslogCefServer: string
         Syslog/CEF Server Address
 
-    SyslogCefTimeZone
-        Time Zone to use when sending Syslog/CEF Protocol log entries (ServerTime, UtcTime)
+    SyslogCefTimeZone: string
+        Time Zone to use when sending Syslog/CEF Protocol log entries
 
-    TmsInstallationPath
-        If TMS is installed, the file location
+    TmsInstallationPath: string
+        If TMS is installed, the file location. This setting is ignored in cloud environments.
 
-    WinRmEndpointUrl
+    WinRmEndpointUrl: string
         Win RM endpoint url
 
-    WriteSyslogToEventLog
-        Enable syslog events to the windows event log
+    WriteSyslogToEventLog: boolean
+        Enable syslog events to the windows event log. This setting is ignored in cloud environments.
 
 # METHODS
 

docs/collections/_abouttopics/about_tssconfigurationemailsettings.md

@@ -20,28 +20,34 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     new()
 
 # PROPERTIES
-    FromEmailAddress
+    FromEmailAddress: string
         All emails will be sent from this address
 
-    SmtpDomain
+    SmtpCheckCertificateRevocation: boolean
+        Check Certificate Revocation when in Implicit SSL Connection Mode
+
+    SmtpDomain: string
         SMTP user domain
 
-    SmtpPassword
+    SmtpPassword: string
         SMTP user password
 
-    SmtpPort
+    SmtpPort: integer (int32)
         Custom port, otherwise the default
 
-    SmtpServer
+    SmtpServer: string
         The resolvable and reachable host name for the outgoing SMTP server
 
-    SmtpUseCredentials
+    SmtpUseCredentials: boolean
         True if credentials are set, false if anonymous
 
-    SmtpUserName
+    SmtpUseImplicitSSL: boolean
+        Implicit SSL Connection Mode
+
+    SmtpUserName: string
         SMTP user name
 
-    smtpUseSSL
+    SmtpUseSSL: boolean
         Use SSL to connect
 
 # METHODS

docs/collections/_abouttopics/about_tssconfigurationfolders.md

@@ -20,22 +20,22 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     new()
 
 # PROPERTIES
-    EnablePersonalFolders
+    EnablePersonalFolders: boolean
         Each user will have a personal folder created and assigned to them
 
-    PersonalFolderName
-        The name of the root personal folder. Each user's personal folder will be named based on the user
+    PersonalFolderName: string
+        The name of the root personal folder. Each user's personal folder will be named based on the user (DisplayName , UsernameAndDomain)
 
-    PersonalFolderNameOption
+    PersonalFolderNameOption: string
         The format for the personal folder name for each user (DisplayName, UsernameAndDomain)
 
-    PersonalFolderWarning
+    PersonalFolderWarning: boolean
         Warning to be shown when creating Secrets if ShowPersonalFolderWarning is true
 
-    RequireViewFolderPermission
+    RequireViewFolderPermission: boolean
         Users will only see folders they have View permissions on
 
-    ShowPersonalFolderWarning
+    ShowPersonalFolderWarning: boolean
         When true the PersonalFolderWarning will be shown when creating Secrets
 
 # METHODS

docs/collections/_abouttopics/about_tssconfigurationgeneral.md

@@ -19,7 +19,7 @@ last_modified_at: 2021-04-04T00:00:00-00:00
 # CONSTRUCTORS
     new()
 
-#PROPERTIES
+# PROPERTIES
     ApplicationSettings
         General Application Configuration Settings
 
@@ -29,12 +29,18 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     Folders
         Folders Configuration
 
+    LauncherSettings
+        Launcher Settings Configuration
+
     LocalUserPasswords
         Local User Passwords configuration
 
     PermissionOptions
         Permission Options Configuration
 
+    ProtocolHandlerSettings
+        Protocol Handler Settings Configuration
+
     UserExperience
         User Experience Configuration
 
@@ -47,8 +53,10 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     TssConfigurationApplicationSettings
     TssConfigurationEmailSettings
     TssConfigurationFolders
+    TssConfigurationLauncherSettings
     TssConfigurationLocalUserPasswords
     TssConfigurationPermissionOptions
+    TssConfigurationProtocolHandlerSettings
     TssConfigurationUserExperience
     TssConfigurationUserInterface
     Get-TssConfiguration

docs/collections/_abouttopics/about_tssconfigurationlocaluserpasswords.md

@@ -20,52 +20,52 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     new()
 
 # PROPERTIES
-    AllowUsersToResetForgottenPasswords
+    AllowUsersToResetForgottenPasswords: boolean
         Whether or not the local password can be reset by the user
 
-    EnableLocalUserPasswordExpiration
+    EnableLocalUserPasswordExpiration: boolean
         Indicates whether or not local users must change their password when it is reset or expires.
 
-    EnableMinimumPasswordAge
+    EnableMinimumPasswordAge: boolean
         Local users cannot change their password until it meets this age
 
-    EnablePasswordHistory
+    EnablePasswordHistory: boolean
         Passwords cannot be reused when enabled and still in stored history
 
-    LocalUserPasswordExpirationDays
+    LocalUserPasswordExpirationDays: integer (int32)
         How many days until the password expires
 
-    LocalUserPasswordExpirationHours
+    LocalUserPasswordExpirationHours: integer (int32)
         How many hours until the password expires
 
-    LocalUserPasswordExpirationMinutes
+    LocalUserPasswordExpirationMinutes: integer (int32)
         How many minutes until the password expires
 
-    MinimumPasswordAgeDays
+    MinimumPasswordAgeDays: integer (int32)
         How many days until password can be changed
 
-    MinimumPasswordAgeHours
+    MinimumPasswordAgeHours: integer (int32)
         How many hours until password can be changed
 
-    MinimumPasswordAgeMinutes
+    MinimumPasswordAgeMinutes: integer (int32)
         How many minutes until password can be changed
 
-    PasswordHistoryItems
+    PasswordHistoryItems: integer (int32)
         How many passwords should be stored in history.
 
-    PasswordMinimumLength
+    PasswordMinimumLength: integer (int32)
         The minimum length required for local user passwords
 
-    PasswordRequireLowercase
+    PasswordRequireLowercase: boolean
         Whether or not the local password must include a lowercase letter
 
-    PasswordRequireNumbers
+    PasswordRequireNumbers: boolean
         Whether or not the local password must include a number
 
-    PasswordRequireSymbols
+    PasswordRequireSymbols: boolean
         Whether or not the local password must include a symbol
 
-    PasswordRequireUppercase
+    PasswordRequireUppercase: boolean
         Whether or not the local password must include an uppercase letter
 
 # METHODS

docs/collections/_abouttopics/about_tssconfigurationpermissionoptions.md

@@ -20,19 +20,19 @@ last_modified_at: 2021-04-04T00:00:00-00:00
     new()
 
 # PROPERTIES
-    AllowDuplicateSecretNames
+    AllowDuplicateSecretNames: boolean
         Allow Secrets to have the same name in the same folder
 
-    AllowViewUserToRetrieveAutoChangeNextPassword
+    AllowViewUserToRetrieveAutoChangeNextPassword: boolean
         Users that only have secret view can see the next password
 
-    DefaultSecretPermissions
+    DefaultSecretPermissions: string
         Default permissions to be applied when a Secret is created (InheritsPermissions, CopyFromFolder, OnlyAllowCreator)
 
-    EnableApprovalFromEmail
+    EnableApprovalFromEmail: boolean
         Allow approval from email
 
-    ForceSecretApproval
+    ForceSecretApproval: string
         Require approval for secrets (None, RequireApprovalForOwnersAndEditors, RequireApprovalForEditors)
 
 # METHODS

docs/collections/_abouttopics/about_tssconfigurationprotocolhandlersettings.md

@@ -0,0 +1,36 @@
+---
+category: configurations
+title: "TssConfigurationProtocolHandlerSettings"
+last_modified_at: 2021-04-05T00:00:00-00:00
+---
+
+# TOPIC
+    This help topic describes the TssConfigurationProtocolHandlerSettings class in the Thycotic.SecretServer module
+
+# CLASS
+    TssConfigurationProtocolHandlerSettings
+
+# INHERITANCE
+    None
+
+# DESCRIPTION
+    The TssConfigurationProtocolHandlerSettings class represents the ConfigurationLauncherSettingsModel object returned by Secret Server endpoint GET /configuration/general
+
+# CONSTRUCTORS
+    new()
+
+# PROPERTIES
+    ProtocolHandlerInstallTimeAllowedDomains: string
+        Allowed Domains/IP Addresses (comma-separated)
+
+    ProtocolHandlerInstallTimeDisableAutoUpdate: boolean
+    Disable Auto Update
+
+    ProtocolHandlerInstallTimeSettingsEnabled: boolean
+        Enable Protocol Handler Install Time Settings
+
+# METHODS
+
+# RELATED LINKS:
+    TssConfigurationGeneral
+    Get-TssConfiguration