Toolkit/Public/Set-RscNasSystem.ps1
|
#Requires -Version 3 function Set-RscNasSystem { <# .SYNOPSIS Updates the properties of a registered NAS system in Rubrik Security Cloud. .DESCRIPTION Modifies a NAS system's hostname, API credentials, SMB credentials, or protocol settings. The cmdlet automatically detects the vendor type (Generic, Isilon, NetApp, FlashBlade, Nutanix) and applies the appropriate vendor-specific configuration. You can identify the NAS system by its ID or by piping a NAS system object from Get-RscNasSystem. .LINK Schema reference: https://rubrikinc.github.io/rubrik-api-documentation/schema/reference .PARAMETER Id The RSC object ID. .PARAMETER NasSystem A NAS system object. Pipe from Get-RscNasSystem. .PARAMETER Hostname The updated hostname or IP address for the NAS system. .PARAMETER HasNfsSupport Enable NFS protocol support (Generic NAS systems only). .PARAMETER HasSmbSupport Enable SMB protocol support. .PARAMETER SmbUsername Username for SMB share access. .PARAMETER SmbPassword Password for SMB share access. .PARAMETER ApiUsername Username for the vendor-specific NAS management API. .PARAMETER ApiPassword Password for the vendor-specific NAS management API. .PARAMETER ApiToken API token for Pure Storage FlashBlade integration. .PARAMETER IsilonChangelistEnabled Enable changelist-based backups for Isilon NAS systems. .PARAMETER ResetGeneratedNamespaceSmbCredentials Remove and recreate system-generated SMB credentials in namespaces. .PARAMETER AsQuery Return the query object instead of running the query. Preliminary read-only queries may still run to gather IDs or other data needed to build the main query. Return the query object instead of executing it. .EXAMPLE Update a NAS system's hostname and credentials by ID. Set-RscNasSystem "5dc44746-38d1-56d8-8570-a54b8dae0208" -Hostname "10.2.46.54" -ApiUsername "admin" -ApiPassword "secret" -HasSmbSupport -SmbUsername "smbuser" -SmbPassword "smbpass" .EXAMPLE Pipe a NAS system object and update its hostname. Get-RscNasSystem -Id "5dc44746-38d1-56d8-8570-a54b8dae0208" | Set-RscNasSystem -Hostname "10.2.46.55" -ApiUsername "admin" -ApiPassword "secret" #> [CmdletBinding(DefaultParameterSetName = "Id")] Param( # The ID of the NAS system. [Parameter(Mandatory = $true, ParameterSetName = "Id", Position = 0)] [ValidateNotNullOrEmpty()] [String]$Id, # The object representing the NAS system. [Parameter(Mandatory = $true, ParameterSetName = "NasSystem", ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] [RubrikSecurityCloud.Types.NasSystem]$NasSystem, # Host name or IP address. [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [String]$Hostname, # NFS supported. [Parameter()] [Switch]$HasNfsSupport, # SMB supported. [Parameter()] [Switch]$HasSmbSupport, # SMB username. [Parameter()] [String]$SmbUsername, # SMB password. [Parameter()] [String]$SmbPassword, # Username to access the vendor-specific NAS API. [Parameter()] [ValidateNotNullOrEmpty()] [String]$ApiUsername, # Password associated with the NAS user account. [Parameter()] [ValidateNotNullOrEmpty()] [String]$ApiPassword, # API token to add or update the Pure NAS system with API integration. [Parameter()] [String]$ApiToken, # Should changelist be enabled. [Parameter(Mandatory = $false)] [Switch]$IsilonChangelistEnabled, # Should reset generated namespace Smb credentials. [Parameter(Mandatory = $false)] [Switch]$ResetGeneratedNamespaceSmbCredentials, # Should Cmdlet return the query object instead of running it. [Parameter(Mandatory = $false)] [Switch]$AsQuery ) Process { $NasVendorType = $null $mutation = New-RscMutation -Gql updateNasSystem ` -AddField Hostname, VendorType $mutation.Var.Input = New-Object -TypeName RubrikSecurityCloud.Types.UpdateNasSystemInput Switch ($PSCmdlet.ParameterSetName) { "Id" { $NasVendorType = (Get-RscNasSystem -Id $Id).VendorType $mutation.Var.Input.Id = $Id } "NasSystem" { $NasVendorType = $NasSystem.VendorType $mutation.Var.Input.Id = $NasSystem.Id } } $mutation.Var.Input.NasSystemUpdateProperties = New-Object -TypeName RubrikSecurityCloud.Types.NasSystemUpdateInput if ($Hostname -ne "") { $mutation.Var.Input.NasSystemUpdateProperties.Hostname = $Hostname } Switch ($NasVendorType) { "GENERIC" { $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters = New-Object -TypeName RubrikSecurityCloud.Types.GenericNasSystemParametersInput $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.HasNfsSupport = $false $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.HasSmbSupport = $false if ($HasNfsSupport) { $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.HasNfsSupport = $true } if ($HasSmbSupport) { $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.HasSmbSupport = $true $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.SmbCredentials = New-Object -TypeName RubrikSecurityCloud.Types.GenericNasSystemCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.SmbCredentials.Username = $SmbUsername $mutation.Var.Input.NasSystemUpdateProperties.GenericNasSystemParameters.SmbCredentials.Password = $SmbPassword } } "ISILON" { $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials = New-Object -TypeName RubrikSecurityCloud.Types.NasApiCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials.ApiUsername = $ApiUsername $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials.ApiPassword = $ApiPassword $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials = New-Object -TypeName RubrikSecurityCloud.Types.NasShareCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials.Username = $SmbUsername $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials.Password = $SmbPassword if ($IsilonChangelistEnabled) { $mutation.Var.Input.NasSystemUpdateProperties.IsIsilonChangelistEnabled = $true } } "NETAPP" { $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials = New-Object -TypeName RubrikSecurityCloud.Types.NasApiCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials.ApiUsername = $ApiUsername $mutation.Var.Input.NasSystemUpdateProperties.NasApiCredentials.ApiPassword = $ApiPassword $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials = New-Object -TypeName RubrikSecurityCloud.Types.NasShareCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials.Username = $SmbUsername $mutation.Var.Input.NasSystemUpdateProperties.SmbCredentials.Password = $SmbPassword } "FLASHBLADE" { $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials = New-Object -TypeName RubrikSecurityCloud.Types.FlashBladeSystemParametersInput $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.ApiToken = $ApiToken $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.HasSmbSupport = $false if ($HasSmbSupport) { $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.HasSmbSupport = $true $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.SmbCredentials = New-Object -TypeName RubrikSecurityCloud.Types.GenericNasSystemCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.SmbCredentials.Username = $SmbUsername $mutation.Var.Input.NasSystemUpdateProperties.NasFlashBladeApiCredentials.SmbCredentials.Password = $SmbPassword } } "NUTANIX_FILE_SERVER" { $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters = New-Object -TypeName RubrikSecurityCloud.Types.NutanixFileServerParametersInput $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.HasSmbSupport = $false if ($HasSmbSupport) { $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.HasSmbSupport = $true $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.SmbCredentials = New-Object -TypeName RubrikSecurityCloud.Types.GenericNasSystemCredentialsInput $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.SmbCredentials.Username = $SmbUsername $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.SmbCredentials.Password = $SmbPassword } $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.ApiUsername = $ApiUsername $mutation.Var.Input.NasSystemUpdateProperties.NutanixFileServerParameters.ApiPassword = $ApiPassword } } if ($AsQuery) { return $mutation } $result = Invoke-Rsc -Query $mutation $result } } |