Public/Set-UnityNFSShare.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
Function Set-UnityNFSShare {

  <#
      .SYNOPSIS
      Modifies NFS share.
      .DESCRIPTION
      Modifies NFS share.
      You need to have an active session with the array.
      .NOTES
      Written by Erwan Quelin under MIT licence - https://github.com/equelin/Unity-Powershell/blob/master/LICENSE
      .LINK
      https://github.com/equelin/Unity-Powershell
      .PARAMETER Session
      Specify an UnitySession Object.
      .PARAMETER ID
      ID of the NFS share.
      .PARAMETER description
      NFS share description
      .PARAMETER isReadOnly
       Indicates whether the NFS share is read-only. Values are:
      - true - NFS share is read-only.
      - false - NFS share is read-write.
      .PARAMETER defaultAccess
      Default access level for all hosts accessing the NFS share.
      .PARAMETER minSecurity
      Minimal security level that must be provided by a client to mount the NFS share.
      .PARAMETER noAccessHosts
      Hosts with no access to the NFS share or its snapshots, as defined by the host resource type.
      .PARAMETER readOnlyHosts
      Hosts with read-only access to the NFS share and its snapshots, as defined by the host resource type.
      .PARAMETER readWriteHosts
      Hosts with read-write access to the NFS share and its snapshots, as defined by the host resource type.
      .PARAMETER rootAccessHosts
      Hosts with root access to the NFS share and its snapshots, as defined by the host resource type.
      .PARAMETER Append
      Append Hosts access to existing configuration
      .EXAMPLE
      Set-UnityNFSShare -id 'NFSShare_2' -rootAccessHosts Host_20 -append

      Set NFS Share with id 'NFSShare_2'
  #>


  [CmdletBinding(SupportsShouldProcess = $True,ConfirmImpact = 'High')]
  Param (
    #Default Parameters
    [Parameter(Mandatory = $false,HelpMessage = 'EMC Unity Session')]
    $session = ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true}),

    #NFSShareModify
    [Parameter(Mandatory = $true,Position = 0,ValueFromPipeline=$True,ValueFromPipelinebyPropertyName=$True,HelpMessage = 'ID of the NFS share')]
    [String[]]$ID,

    #$nfsShareParameters
    [Parameter(Mandatory = $false,HelpMessage = 'NFS share description')]
    [String]$description,
    [Parameter(Mandatory = $false,HelpMessage = 'Indicates whether the NFS share is read-only')]
    [bool]$isReadOnly = $false,
    [Parameter(Mandatory = $false,HelpMessage = 'Default access level for all hosts accessing the NFS share.')]
    [NFSShareDefaultAccessEnum]$defaultAccess,
    [Parameter(Mandatory = $false,HelpMessage = 'Minimal security level that must be provided by a client to mount the NFS share.')]
    [NFSShareSecurityEnum]$minSecurity,
    [Parameter(Mandatory = $false,HelpMessage = 'Hosts with no access to the NFS share or its snapshots.')]
    [string[]]$noAccessHosts,
    [Parameter(Mandatory = $false,HelpMessage = 'Hosts with read-only access to the NFS share and its snapshots.')]
    [string[]]$readOnlyHosts,
    [Parameter(Mandatory = $false,HelpMessage = 'Hosts with read-write access to the NFS share and its snapshots.')]
    [string[]]$readWriteHosts,
    [Parameter(Mandatory = $false,HelpMessage = 'Hosts with root access to the NFS share and its snapshots.')]
    [string[]]$rootAccessHosts,
    [Parameter(Mandatory = $false,HelpMessage = 'Append Hosts access to existing configuration')]
    [Switch]$append
  )

  Begin {
    Write-Debug -Message "[$($MyInvocation.MyCommand)] Executing function"

    # Variables
    $URI = '/api/instances/storageResource/<id>/action/modifyFilesystem'
    $Type = 'NFS Share'
    $TypeName = 'UnityNFSShare'
    $StatusCode = 204
  }

  Process {

    Foreach ($sess in $session) {

      Write-Debug -Message "Processing Session: $($sess.Server) with SessionId: $($sess.SessionId)"

      If ($Sess.TestConnection()) {

        Foreach ($i in $ID) {

          # Determine input and convert to object if necessary
          Switch ($i.GetType().Name)
          {
            "String" {
              $Object = get-UnityNFSShare -Session $Sess -ID $i
              $ObjectID = $Object.id
              If ($Object.Name) {
                $ObjectName = $Object.Name
              } else {
                $ObjectName = $ObjectID
              }
            }
            "$TypeName" {
              Write-Verbose "Input object type is $($i.GetType().Name)"
              $ObjectID = $i.id
              If ($Object = Get-UnityNFSShare -Session $Sess -ID $ObjectID) {
                If ($Object.Name) {
                  $ObjectName = $Object.Name
                } else {
                  $ObjectName = $ObjectID
                }          
              }
            }
          }

          If ($ObjectID) {

            $UnitystorageResource = Get-UnitystorageResource -Session $sess | Where-Object {($_.filesystem.id -like $Object.Filesystem.id)}

            #### REQUEST BODY

            # Creation of the body hash
            $body = @{}

            $body["nfsShareModify"] = @{}
                
              #$NFSShareParameters
              $nfsShareModifyParameters = @{}

              $NFSShareModifyParameters["nfsShare"] = @{}
                  $NFSShare = @{}
                  $NFSShare['id'] = $ObjectID
              $NFSShareModifyParameters["nfsShare"] = $NFSShare
              
              #$nfsShareParameters
              $nfsShareModifyParameters["nfsShareParameters"] = @{}
                
                $nfsShareParameters = @{}

                If ($PSBoundParameters.ContainsKey('description')) {
                  $nfsShareParameters["description"] = "$($description)"
                }

                $nfsShareParameters["isReadOnly"] = $isReadOnly

                If ($PSBoundParameters.ContainsKey('defaultAccess')) {
                  $nfsShareParameters["defaultAccess"] = $defaultAccess
                }

                If ($PSBoundParameters.ContainsKey('minSecurity')) {
                  $nfsShareParameters["minSecurity"] = $minSecurity
                }

                If ($PSBoundParameters.ContainsKey('noAccessHosts')) {
                
                  $nfsShareParameters["noAccessHosts"] = @()

                  foreach ($h in $noAccessHosts) {

                        $HostParam = @{}
                        $HostParam['id'] = $h

                        $nfsShareParameters["noAccessHosts"] += $HostParam
                  }

                  If ($append) {
                    foreach ($h in $Object.noAccessHosts) {
                      $nfsShareParameters["noAccessHosts"] += $h
                    }
                  } 
                }

                If ($PSBoundParameters.ContainsKey('readOnlyHosts')) {
                
                  $nfsShareParameters["readOnlyHosts"] = @()

                  foreach ($h in $readOnlyHosts) {

                        $HostParam = @{}
                        $HostParam['id'] = $h

                    $nfsShareParameters["readOnlyHosts"] += $HostParam
                  }
            
                  If ($append) {
                    foreach ($h in $Object.readOnlyHosts) {
                      $nfsShareParameters["readOnlyHosts"] += $h
                    }
                  } 
                }

                If ($PSBoundParameters.ContainsKey('readWriteHosts')) {
                
                  $nfsShareParameters["readWriteHosts"] = @()

                  foreach ($h in $readWriteHosts) {

                        $HostParam = @{}
                        $HostParam['id'] = $h

                    $nfsShareParameters["readWriteHosts"] += $HostParam
                  }
            
                  If ($append) {
                    foreach ($h in $Object.readWriteHosts) {
                      $nfsShareParameters["readWriteHosts"] += $h
                    }
                  } 
                }

                If ($PSBoundParameters.ContainsKey('rootAccessHosts')) {
                
                  $nfsShareParameters["rootAccessHosts"] = @()

                  foreach ($h in $rootAccessHosts) {

                        $HostParam = @{}
                        $HostParam['id'] = $h

                    $nfsShareParameters["rootAccessHosts"] += $HostParam
                  }
            
                  If ($append) {
                    foreach ($h in $Object.rootAccessHosts) {
                      $nfsShareParameters["rootAccessHosts"] += $h
                    }
                  } 
                }

              $nfsShareModifyParameters["nfsShareParameters"] = $nfsShareParameters


            $body["nfsShareModify"] = $nfsShareModifyParameters

            If (-not $append) {
              Write-Warning -Message 'The existing host access parameters will be overwritten by the new settings. It could result to data unavailibility. Use the -Append parameter to add the new settings to the existing configuration.'
            }
              
            ####### END BODY - Do not edit beyond this line

            #Show $body in verbose message
            $Json = $body | ConvertTo-Json -Depth 10
            Write-Verbose $Json 

            #Building the URL
            $FinalURI = $URI -replace '<id>',$UnitystorageResource.id

            $URL = 'https://'+$sess.Server+$FinalURI
            Write-Verbose "URL: $URL"

            #Sending the request
            If ($pscmdlet.ShouldProcess($Sess.Name,"Modify $Type $ObjectName")) {
              $request = Send-UnityRequest -uri $URL -Session $Sess -Method 'POST' -Body $Body
            }
            
            If ($request.StatusCode -eq $StatusCode) {

              Write-Verbose "$Type with ID $ObjectID has been modified"

              Get-UnityNFSShare -Session $Sess -ID $ObjectID

            }  # End If ($request.StatusCode -eq $StatusCode)
          } else {
            Write-Warning -Message "$Type with ID $i does not exist on the array $($sess.Name)"
          } # End If ($ObjectID)
        } # End Foreach ($i in $ID)
      } # End If ($Sess.TestConnection())
    } # End Foreach ($sess in $session)
  } # End Process
} # End Function