Hi,
Here's a PowerShell Example for you:
Param(
[Parameter(Mandatory = $True, HelpMessage="The Cluster name or IP Address")]
[String]$Cluster,
[Parameter(Mandatory = $True, HelpMessage="The Vserver Name")]
[String]$Vserver,
[Parameter(Mandatory = $True, HelpMessage="The Volume Name")]
[String]$Volume,
[Parameter(Mandatory = $True, HelpMessage="The Volume Analytics state")]
[ValidateSet("on","off")]
[String]$State,
[Parameter(Mandatory = $False, HelpMessage = "The Credentials to authenticate to ONTAP")]
[System.Management.Automation.PSCredential]$Credential
)
#'------------------------------------------------------------------------------
Function Get-OntapAuthorization{
[CmdletBinding()]
Param(
[Parameter(Mandatory = $True, HelpMessage = "The Credential to authenticate to the ONTAP cluster")]
[ValidateNotNullOrEmpty()]
[System.Management.Automation.PSCredential]$Credential
)
#'--------------------------------------------------------------------------
#'Set the authentication header to connect to the cluster.
#'--------------------------------------------------------------------------
$auth = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($Credential.UserName + ':' + $Credential.GetNetworkCredential().Password))
$headers = @{
"Authorization" = "Basic $auth"
"Accept" = "application/json"
"Content-Type" = "application/json"
}
Return $headers;
}#'End Function Get-OntapAuthorization.
#'------------------------------------------------------------------------------
Function Invoke-OntapRestApi{
[CmdletBinding()]
Param(
[Parameter(Mandatory = $True, HelpMessage = "The Cluster Name or IP Address")]
[String]$Cluster,
[Parameter(Mandatory = $True, HelpMessage = "The REST API Method to Invoke")]
[ValidateSet("get","patch","post","delete")]
[String]$Method,
[Parameter(Mandatory = $False, HelpMessage = "The JSON payload used for creating or modifying an object")]
[String]$Body,
[Parameter(Mandatory = $True, HelpMessage = "The URI to invoke")]
[String]$Uri,
[Parameter(Mandatory = $True, HelpMessage = "The Credential to authenticate to the Cluster")]
[ValidateNotNullOrEmpty()]
[System.Management.Automation.PSCredential]$Credential
)
#'--------------------------------------------------------------------------
#'Exit if the body is not provided when calling the post or patch method.
#'--------------------------------------------------------------------------
If(($Method -eq "post" -Or $Method -eq "patch") -And ($Null -eq $Body)){
Write-Warning -Message "The body parameter must be provided when invoking the patch or post method"
Return $Null;
}
#'--------------------------------------------------------------------------
#'Set the Authentication header.
#'--------------------------------------------------------------------------
$headers = Get-OntapAuthorization -Credential $Credential
#'--------------------------------------------------------------------------
#'Invoke the command via the private REST CLI.
#'--------------------------------------------------------------------------
Try{
If($Method -eq "post" -Or $Method -eq "patch"){
$bodyJson = $body | ConvertFrom-Json | ConvertTo-Json -Compress -Depth 100
$response = Invoke-RestMethod -Method $Method -Body $bodyJson -Uri $Uri -Headers $headers -ErrorAction Stop
Write-Host "JSON Payload`: $bodyJson"
}Else{
$response = Invoke-RestMethod -Method $Method -Uri $Uri -Headers $headers -ErrorAction Stop
}
Write-Host "Invoked ""$Method"" on URI`: $Uri"
}Catch{
Write-Warning -Message $("Failed Invoking ""$Method"" on URI`: ""$Uri"". Error " + $_.Exception.Message)
Return $Null;
}
Return $response;
}#'End Function Invoke-OntapRestApi.
#'------------------------------------------------------------------------------
#'Enumerate the Volume.
#'------------------------------------------------------------------------------
$headers = Get-OntapAuthorization -Credential $Credential
$uri = "https://$cluster/api/storage/volumes?name=$Volume&svm.name=$Vserver"
Try{
$response = Invoke-RestMethod -Method GET -Uri $Uri -Headers $headers -ErrorAction Stop
Write-Host "Enumerated volume ""$Volume"" on vserver ""$Vserver"" on cluster ""$Cluster"" using URI`: $uri"
}Catch{
Write-Warning -Message $("Failed Invoking ""$Method"" on URI`: ""$Uri"". Error " + $_.Exception.Message)
}
If($Null -ne $response){
[String]$volumeId = $response.records.uuid
}Else{
Write-Warning -Message "The volume ""$Volume"" was not found on vserver ""$Vserver"" on Cluster ""$Cluster"""
Exit 0
}
#'------------------------------------------------------------------------------
#'Set the Volume Analytics state.
#'------------------------------------------------------------------------------
$uri = "https://$cluster/api/storage/volumes/$volumeId"
$analytics = @{"analytics.state" = $State}
$body = $analytics | ConvertTo-Json
Try{
$response = Invoke-OntapRestApi -Cluster $Cluster -Uri $uri -Method Patch -Body $body -Credential $credential -ErrorAction Stop
Write-Host "Successfully Set Volume analytics state to ""$State"" for volume ""$Volume"" on vserver ""$Vserver"" on cluster ""$Cluster"" using URI ""$uri"""
}Catch{
Write-Warning -Message $("Failed Setting Volume analytics state to ""$State"" for volume ""$Volume"" on vserver ""$Vserver"" on cluster ""$Cluster"" using URI ""$uri"". Error " + $_.Exception.Message)
Exit -1
}
#'------------------------------------------------------------------------------
Usage:
PS C:\Scripts> .\EnableVolumeAnalytics.ps1 -Cluster 192.168.100.2 -Vserver vserver1 -Volume cifs_data_001 -State on -Credential $credential
Enumerated volume "cifs_data_001" on vserver "vserver1" on cluster "192.168.100.2" using URI: https://192.168.100.2/api/storage/volumes?name=cifs_data_001&svm.name=vserver1
JSON Payload: {"analytics.state":"on"}
Invoked "Patch" on URI: https://192.168.100.2/api/storage/volumes/d07c117b-10f8-11ef-ac71-005056a0bb1e
Successfully Set Volume analytics state to "on" for volume "cifs_data_001" on vserver "vserver1" on cluster "192.168.100.2" using URI "https://192.168.100.2/api/storage/volumes/d07c117b-10f8-11ef-ac71-005056a0bb1e"
PS C:\Scripts> .\EnableVolumeAnalytics.ps1 -Cluster 192.168.100.2 -Vserver vserver1 -Volume cifs_data_001 -State off -Credential $credential
Enumerated volume "cifs_data_001" on vserver "vserver1" on cluster "192.168.100.2" using URI: https://192.168.100.2/api/storage/volumes?name=cifs_data_001&svm.name=vserver1
JSON Payload: {"analytics.state":"off"}
Invoked "Patch" on URI: https://192.168.100.2/api/storage/volumes/d07c117b-10f8-11ef-ac71-005056a0bb1e
Successfully Set Volume analytics state to "off" for volume "cifs_data_001" on vserver "vserver1" on cluster "192.168.100.2" using URI "https://192.168.100.2/api/storage/volumes/d07c117b-10f8-11ef-ac71-005056a0bb1e"
Hope that helps
/Matt
If this post resolved your issue, help others by selecting ACCEPT AS SOLUTION or adding a KUDO.
