Public/Set-UnityMgmtInterfaceSettings.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
Function Set-UnityMgmtInterfaceSettings {

  <#
      .SYNOPSIS
      Modifies global management interfaces settings.
      .DESCRIPTION
      Modifies global management interfaces settings.
      It is not allowed to set both IPv4 and IPv6 to Disabled at the same time, in any sequence.
      It is not allowed to set both IPv4 and IPv6 to Auto in one request.
      IPv4 or IPv6 may be set to Auto only if the other class IP address already exists, either set as a static IP address or obtained in Auto mode.
      The Static can be set only implicitly by creating the mgmtInterface object.
      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 v4ConfigMode
      New IPv4 config mode. Might be:
      - Disabled: Management access is disabled.
      - Static: Management interface address is set manually with Set-UnityMgmtInterface.
      - Auto: Management interface address is configured by DHCP.
      .PARAMETER v6ConfigMode
      New IPv6 config mode. Might be:
      - Disabled: Management access is disabled.
      - Static: Management interface address is set manually with Set-UnityMgmtInterface.
      - Auto: Management interface address is configured by SLAAC.
      .EXAMPLE
      Set-UnityMgmtInterfaceSettings -Addresses '192.168.0.1','192.168.0.2'

      replace the exsting address list for this DNS server with this new list.
  #>


  [CmdletBinding(SupportsShouldProcess = $True,ConfirmImpact = 'High')]
  Param (
    [Parameter(Mandatory = $false,HelpMessage = 'EMC Unity Session')]
    $session = ($global:DefaultUnitySession | where-object {$_.IsConnected -eq $true}),
    
    [Parameter(Mandatory = $false,HelpMessage = 'New IPv4 config mode. Might be Disabled, Static or Auto')]
    [InterfaceConfigModeEnum]$v4ConfigMode,
    [Parameter(Mandatory = $false,HelpMessage = 'New IPv6 config mode. Might be Disabled, Static or Auto')]
    [InterfaceConfigModeEnum]$v6ConfigMode
  )

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

    # Variables
    $URI = '/api/instances/mgmtInterfaceSettings/0/action/modify'
    $Type = 'Global management interfaces settings'
    $StatusCode = 204
  }

  Process {

    Foreach ($sess in $session) {

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

      If ($Sess.TestConnection()) {

          #### REQUEST BODY

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

          If ($PSBoundParameters.ContainsKey('v4ConfigMode')) {
            $body["v4ConfigMode"] = $v4ConfigMode
          }

          If ($PSBoundParameters.ContainsKey('v6ConfigMode')) {
            $body["v6ConfigMode"] = $v6ConfigMode
          }

          ####### END BODY - Do not edit beyond this line

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

          #Building the URI
          $URL = 'https://'+$sess.Server+$URI
          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-UnityMgmtInterfaceSettings -Session $Sess
          } # End If ($ObjectID)
      } # End If ($Sess.TestConnection())
    } # End Foreach ($sess in $session)
  } # End Process
} # End Function