Scripts/Vlan/update-cohesityvlan.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
function Update-CohesityVlan {
    <#
        .SYNOPSIS
        Updates the vlan.
        .DESCRIPTION
        The Update-CohesityVlan function is used to update vlan.
        .NOTES
        Published by Cohesity
        .LINK
        https://cohesity.github.io/cohesity-powershell-module/#/README
        .EXAMPLE
        Update-CohesityVlan -InterfaceGroupName intf_group1 -VlanId 18 -Subnet 1.18.4.0 -NetmaskBitsForSubnet 20 -Gateway 1.18.4.1
        .EXAMPLE
        Get-CohesityVlan -VlanId 11 | Update-CohesityVlan -InterfaceGroupName intf_group1 -Subnet 1.2.1.1
    #>

    [CmdletBinding(DefaultParameterSetName = "InterfaceGroupName", SupportsShouldProcess = $True, ConfirmImpact = "High")]
    Param(
        [Parameter(Mandatory = $true, ParameterSetName = 'InterfaceGroupName')]
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo')]
        [ValidateNotNullOrEmpty()]
        [string]$InterfaceGroupName,
        [Parameter(Mandatory = $true, ParameterSetName = 'VlanId')]
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo')]
        [ValidateNotNullOrEmpty()]
        [int]$VlanId,
        [Parameter(Mandatory = $true, ParameterSetName = 'Subnet')]
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo')]
        [ValidateNotNullOrEmpty()]
        [string]$Subnet,
        [Parameter(Mandatory = $true, ParameterSetName = 'NetmaskBitsForSubnet')]
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo')]
        [ValidateNotNullOrEmpty()]
        [int]$NetmaskBitsForSubnet,
        [Parameter(Mandatory = $false, ParameterSetName = 'Gateway')]
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo')]
        $Gateway,
        [Parameter(Mandatory = $false, ParameterSetName = 'PipedVlanInfo', ValueFromPipeline = $True, DontShow = $True)]
        $VlanInfo = $null
    )

    Begin {
        if (-not (Test-Path -Path "$HOME/.cohesity")) {
            throw "Failed to authenticate. Please connect to the Cohesity Cluster using 'Connect-CohesityCluster'"
        }
        $cohesitySession = Get-Content -Path $HOME/.cohesity | ConvertFrom-Json
        $cohesityCluster = $cohesitySession.ClusterUri
        $cohesityToken = $cohesitySession.Accesstoken.Accesstoken
    }

    Process {
        if ($PSCmdlet.ShouldProcess("Update vlan parameters")) {
            $vlanObject = $null
            if ($VlanInfo) {
                # Object sailing through the pipe
                $vlanObject = $VlanInfo
            }
            else {
                $interfaceGroupObject = Get-CohesityInterfaceGroup | Where-Object { $_.name -eq $InterfaceGroupName }
                if ($null -eq $interfaceGroupObject) {
                    Write-Output "Interface group name '$InterfaceGroupName' does not exists"
                    return
                }
                # Look into the documentation for constructing the ifaceGroupName attribute
                $virtualInterfaceGroupName = $interfaceGroupObject.name + "." + $VlanId
                $vlanObject = Get-CohesityVlan | Where-Object { $_.id -eq $VlanId -and $_.ifaceGroupName -eq $virtualInterfaceGroupName }
            }

            if ($null -eq $vlanObject) {
                Write-Output "VLAN id '$VlanId' with interface group name '$InterfaceGroupName' does not exists"
                return
            }
            $cohesityClusterURL = $cohesityCluster + '/irisservices/api/v1/public/vlans/' + $vlanObject.id
            $cohesityHeaders = @{'Authorization' = 'Bearer ' + $cohesityToken }

            $payload = @{
                id             = $vlanObject.id
                gateway        = $vlanObject.gateway
                subnet         = @{
                    ip          = $vlanObject.subnet.ip
                    netmaskBits = $vlanObject.subnet.netmaskBits
                }
                ifaceGroupName = $vlanObject.ifaceGroupName
                ips            = $vlanObject.ips
                vlanName       = $vlanObject.vlanName
            }
            if ($Gateway) {
                $payload.gateway = $Gateway
            }
            if ($Subnet) {
                $payload.subnet.ip = $Subnet
            }
            if ($NetmaskBitsForSubnet) {
                $payload.subnet.netmaskBits = $NetmaskBitsForSubnet
            }
            # The UI does not set the vlan name while creating, subsequently while updating the vlan, the ifaceGroupName is considered as vlanName
            if ($null -eq $payload.vlanName) {
                $payload.vlanName = $vlanObject.ifaceGroupName
            }
            $payloadJson = $payload | ConvertTo-Json -Depth 100
            $resp = Invoke-RestApi -Method Put -Uri $cohesityClusterURL -Headers $cohesityHeaders -Body $payloadJson
            if ($resp) {
                $resp
            }
            else {
                $errorMsg = "VLAN : Failed to update"
                Write-Output $errorMsg
                CSLog -Message $errorMsg
            }
        }
    }

    End {
    }
}