save current changes

microsoft · Aug 19, 2024 · d5c329e · d5c329e
1 parent 759d7b6
commit d5c329e
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 18 deletions.
diff --git a/src/modules/SdnDiag.NetworkController/private/Get-SdnAuditLogSetting.ps1 b/src/modules/SdnDiag.NetworkController/private/Get-SdnAuditLogSetting.ps1
@@ -0,0 +1,47 @@
+function Get-SdnAuditLogSetting {
+    <#
+    .SYNOPSIS
+        Retrieves the audit log settings for the Network Controller
+    .PARAMETER NcUri
+        Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.
+    .PARAMETER Credential
+        Specifies a user account that has permission to perform this action. The default is the current user.
+    #>
+
+    [CmdletBinding()]
+    param (
+        [Parameter(Mandatory = $true)]
+        [Uri]$NcUri,
+
+        [Parameter(Mandatory = $false)]
+        [System.Management.Automation.PSCredential]
+        [System.Management.Automation.Credential()]
+        $Credential = [System.Management.Automation.PSCredential]::Empty
+    )
+
+    $object = [PSCustomObject]@{
+        Enabled = $false
+        OutputDirectory = $null
+    }
+
+    # verify that the environment we are on supports at least v3 API and later
+    # as described in https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-ncnbi/dc23b547-9ec4-4cb3-ab20-a6bfe01ddafb
+    $currentRestVersion = (Get-SdnResource -NcUri $NcUri.AbsoluteUri -Resource 'Discovery' -Credential $NcRestCredential).properties.currentRestVersion
+    [int]$currentRestVersionInt = $currentRestVersion.Replace('V','').Replace('v','').Trim()
+    if ($currentRestVersionInt -lt 3) {
+        "Auditing requires API version 3 or later. Network Controller supports version {0}" -f $currentRestVersionInt | Trace-Output -Level:Warning
+        return
+    }
+
+    # check to see that auditing has been enabled
+    $auditSettingsConfig = Get-SdnResource -NcUri $NcUri.AbsoluteUri -Resource 'AuditingSettingsConfig' -ApiVersion $currentRestVersion -Credential $NcRestCredential
+    if ([string]::IsNullOrEmpty($auditSettingsConfig.properties.outputDirectory)) {
+        return $object
+    }
+    else {
+        $object.Enabled = $true
+        $object.OutputDirectory = $auditSettingsConfig.properties.outputDirectory
+
+        return $object
+    }
+}
diff --git a/src/modules/SdnDiag.NetworkController/public/Get-SdnAuditLog.ps1 b/src/modules/SdnDiag.NetworkController/public/Get-SdnAuditLog.ps1
@@ -1,4 +1,3 @@
-
 function Get-SdnAuditLog {
     <#
     .SYNOPSIS
@@ -37,23 +36,10 @@ function Get-SdnAuditLog {
         $Credential = [System.Management.Automation.PSCredential]::Empty
     )
 
-    # verify that the environment we are on supports at least v3 API and later
-    # as described in https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-ncnbi/dc23b547-9ec4-4cb3-ab20-a6bfe01ddafb
-    $currentRestVersion = (Get-SdnResource -NcUri $NcUri.AbsoluteUri -Resource 'Discovery' -Credential $NcRestCredential).properties.currentRestVersion
-    [int]$currentRestVersionInt = $currentRestVersion.Replace('V','').Replace('v','').Trim()
-    if ($currentRestVersionInt -lt 3) {
-        "Auditing requires API version 3 or later. Network Controller supports version {0}" -f $currentRestVersionInt | Trace-Output -Level:Warning
-        return
-    }
-
-    # check to see that auditing has been enabled
-    $auditSettingsConfig = Get-SdnResource -NcUri $NcUri.AbsoluteUri -Resource 'AuditingSettingsConfig' -ApiVersion $currentRestVersion -Credential $NcRestCredential
-    if ([string]::IsNullOrEmpty($auditSettingsConfig.properties.outputDirectory)) {
-        "Audit logging is not enabled" | Trace-Output
-        return
-    }
-    else {
-        "Audit logging location: {0}" -f $auditSettingsConfig.properties.outputDirectory | Trace-Output
+    $auditSettings = Get-SdnAuditLogSetting -NcUri $NcUri -Credential $NcRestCredential
+    if ($auditSettings.Enabled -eq $false) {
+        "Audit logs are not enabled" | Trace-Output
+        return $null
     }
 
     # if $ComputerName was not specified, then attempt to locate the servers within the SDN fabric