Merge pull request #72 from dbroeglin/feature/better-housekeeping

Added Remove-NSSystemFile, Get-NSHardware and corrected Get-NSSystemFile

Author: devblackops

NetScaler/NetScaler.psd1

@@ -112,6 +112,7 @@ FunctionsToExport = @(
     'Get-NSDnsNameServer',
     'Get-NSDnsSuffix',
     'Get-NSFeature',
+    'Get-NSHardware',
     'Get-NSHostname',
     'Get-NSIPResource',
     'Get-NSIP6Resource',
@@ -190,6 +191,7 @@ FunctionsToExport = @(
     'Remove-NSResponderAction',
     'Remove-NSSSLCertificateLink',
     'Remove-NSSSLProfile',
+    'Remove-NSSystemFile',
     'Remove-NSVPNSessionPolicy',
     'Remove-NSVPNSessionProfile',
     'Restart-NetScaler',

NetScaler/Private/_InvokeNSRestApiGet.ps1

@@ -46,7 +46,7 @@ function _InvokeNSRestApiGet {
 
     if ($Name.Count -gt 0) {
         foreach ($item in $Name) {
-            $response = _InvokeNSRestApi -Session $Session -Method Get -Type $Type -Resource $item -Action Get -Filters $Filters
+            $response = _InvokeNSRestApi -Session $Session -Method Get -Type $Type -Resource $item -Action Get -Filters $Filters -Arguments $Arguments
             if ($response.errorcode -ne 0) { throw $response }
             if ($Response.psobject.properties.name -contains $Type) {
                 $response.$Type

NetScaler/Public/Get-NSHardware.ps1

@@ -0,0 +1,52 @@
+<#
+Copyright 2017 Dominique Broeglin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+#>
+
+function Get-NSHardware {
+    <#
+    .SYNOPSIS
+        Gets the hardware information for the NetScaler appliance.
+
+    .DESCRIPTION
+        Gets the hardware information for the NetScaler appliance.
+
+    .EXAMPLE
+        Get-NSHardware
+
+        Get the NetScaler hardware information.
+
+    .EXAMPLE
+        Get-NSHardware | Select-Object -ExpandProperty host
+
+        Get the NetScaler host ID (used for licenses). For some reason the 'hostid' property contains 
+        another, numeric, value. 
+
+    .PARAMETER Session
+        The NetScaler session object.
+
+    #>
+    [cmdletbinding()]
+    param(
+        $Session = $script:session
+    )
+
+    begin {
+        _AssertSessionActive
+    }
+
+    process {
+        _InvokeNSRestApiGet -Session $Session -Type nshardware
+    }
+}

NetScaler/Public/Get-NSSystemFile.ps1

@@ -52,15 +52,13 @@ function Get-NSSystemFile {
     param(
         $Session = $Script:Session,
 
-        [Parameter(Position=0, ParameterSetName='get')]
+        [Parameter(Position=0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [string[]]$Name = @(),
 
         [Parameter(ParameterSetName='search')]
-
         [string]$Filename,
 
-        [Parameter(ParameterSetName='search')]
-
+        [Parameter(Mandatory)]
         [string]$FileLocation
     )
 
@@ -70,13 +68,12 @@ function Get-NSSystemFile {
 
     process {
         # Contruct a filter hash if we specified any filters
-        $Filters = @{}
+        $Filters = @{
+            filelocation = $FileLocation
+        }
         if ($PSBoundParameters.ContainsKey('Filename')) {
             $Filters['filename'] = $Filename
         }
-        if ($PSBoundParameters.ContainsKey('FileLocation')) {
-            $Filters['filelocation'] = $FileLocation
-        }
         _InvokeNSRestApiGet -Session $Session -Type systemfile -Name $Name -Arguments $Filters
     }
-}
+}

NetScaler/Public/Install-NSLicense.ps1

@@ -46,7 +46,7 @@ function Install-NSLicense {
             if (Test-Path -Path $_) {
                 $true
             } else {
-                throw 'Cannot file license file. Path does not exist.'
+                throw 'Cannot find license file. Path does not exist.'
             }
         })]
         [string]$Path,

NetScaler/Public/Remove-NSSystemFile.ps1

@@ -0,0 +1,67 @@
+<#
+Copyright 2017 Dominique Broeglin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+#>
+
+function Remove-NSSystemFile {
+    <#
+    .SYNOPSIS
+        Remove a system file from the NetScaler.
+
+    .DESCRIPTION
+        Remove a system file from the NetScaler.
+
+    .EXAMPLE
+        Remove-NSSystemFile -Name 'test.tgz'
+
+        Remove a system file called 'test.tgz' from the NetScaler.
+
+    .PARAMETER Session
+        The NetScaler session object.
+
+    .PARAMETER Name
+        Name of the system file to remove.
+
+    .PARAMETER FileLocation
+        Location of the system file to remove.
+
+    .PARAMETER Force
+        Suppress confirmation when removing a system file.
+    #>
+    [cmdletbinding(SupportsShouldProcess = $true, ConfirmImpact='Medium')]
+    param(
+        $Session = $script:session,
+
+        [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
+        [Alias('Filename')]
+        [string[]]$Name,
+
+        [Parameter(Mandatory)]
+        [string]$FileLocation,
+
+        [switch]$Force
+    )
+
+    begin {
+        _AssertSessionActive
+    }
+
+    process {
+        foreach ($item in $Name) {
+            if ($Force -or $PSCmdlet.ShouldProcess($item, "Delete file $FileLocation/$Name")) {
+                _InvokeNSRestApi -Session $Session -Method DELETE -Type systemfile -Resource $item -Action delete -Arguments @{ filelocation = $FileLocation }
+            }
+        }
+    }
+}