Working with iDRAC9 Redfish API using PowerShell - Part 2

In this article I will explain briefly about the JSON response from iDRAC and how you can navigate through the Redfish API tree structure to get all the required information. Now, lets have a look at the URIs. 

Query the computer system collection:

$result1 = Invoke-RestMethod -Uri "https://$($idrac_ip)/redfish/v1/Systems" -Credential $Credentials -Method Get -UseBasicParsing -ContentType 'application/json'

Response: 

You can see one member with URI /redfish/v1/Systems/System.Embedded.1

Below is a sample screen shot of JSON output when you try to query the above listed member system. 

You can get some of the basic information straight away from the above JSON response. And these are organized in hierarchy where you can drill down to each object and get the required details. Below diagram shows basic iDRAC Redfish API tree structure.

Example: You can get details/ health status of  storage controller as shown below.

Query:

$result2 = Invoke-RestMethod -Uri "https://$($idrac_ip)/redfish/v1/Systems/ System.Embedded.1/Storage/Controllers/NonRAID.Integrated.1-1" -Credential $Credentials -Method Get -UseBasicParsing -ContentType 'application/json'

Response:

Hope it was useful. Cheers!

References:

Working with iDRAC9 Redfish API using PowerShell - Part 1

iDRAC9 Redfish API reference guide

github.com/dell/iDRAC-Redfish-Scripting

Working with iDRAC9 Redfish API using PowerShell - Part 1

Note: This blog has moved! New location vineethac.blogspot.com

Redfish is a industry standard protocol and specification defined by Distributed Management Task Force (DMTF) for performing systems/ IT infrastructure management actions using RESTful methodology. It is a next generation systems management interface standard which is simple, secure, scalable. Redfish uses JSON data format and transports payload over HTTPS. Initial releases of Redfish focused primarily on systems management and was targeted to be a replacement for IPMI over LAN protocol. Now the capabilities have been extended over the past few years providing a rich set of features and support for network, memory, storage devices etc. Over time the scope of Redfish is being expanded to fit more use cases as the forum is working with several partner organizations. Promoters of this standard include several companies like Broadcom, Cisco, Dell, HP, VMware, Intel, Microsoft etc.

Now, lets have a look at how to connect to iDRAC Redfish API using PowerShell. Redfish provides two authentication methods. Basic authentication and Session-based authentication. Here I will explain basic authentication using username and password for each Redfish API request to iDRAC.

#To fix the connection issues to iDRAC REST API

add-type @"

    using System.Net;

    using System.Security.Cryptography.X509Certificates;

    public class TrustAllCertsPolicy : ICertificatePolicy {

    public bool CheckValidationResult(

        ServicePoint srvPoint, X509Certificate certificate,

        WebRequest request, int certificateProblem) {

        return true;

        }

    }

"@

[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy

[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12 -bor [System.Net.SecurityProtocolType]::Tls11

#Get iDRAC creds

$Credentials = Get-Credential -Message "Enter iDRAC Creds"

#URI to get basic system info

$u1 = "https://192.168.10.11/redfish/v1/Systems/System.Embedded.1"

#Using Invoke-RestMethod

$result1 = Invoke-RestMethod -Uri $u1 -Credential $Credentials -Method Get -UseBasicParsing -ContentType 'application/json'

Output:

Hope it was useful. Cheers!

References:
iDRAC9 Redfish API reference guide
github.com/dell/iDRAC-Redfish-Scripting

Working with ScaleIO REST API using PowerShell - Part 3

As you all know disk drives are the most important and basic building blocks of a storage system. In order to ensure data availability, the disk drives in your storage system should always stay healthy. Unhealthy drives not only cause risk to your data but also contribute to degraded performance. In this article, I will show how to query and get disk health-related information in a ScaleIO cluster using REST API and PowerShell. 

Please refer my previous posts for API authentication, token generation and 'Invoke-RestMethod'.

Working with ScaleIO REST API using PowerShell - Part 1

Working with ScaleIO REST API using PowerShell - Part 2

#Query all devices in the ScaleIO cluster

$all_devices = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/types/Device/instances " -Method Get -Headers $ScaleIOAuthHeaders)  

#Select necessary properties and sort

$all_devices = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/types/Device/instances " -Method Get -Headers $ScaleIOAuthHeaders) | select sdsId, storagePoolId, name, deviceCurrentPathName, errorState, deviceState, ssdEndOfLifeState, temperatureState, aggregatedState  | sort sdsId | ft -AutoSize

#Sample output

Hope this was helpful. Please refer to ScaleIO 2.5 API reference guide for more details. Cheers!

Working with ScaleIO REST API using PowerShell - Part 2

In my previous post, I explained how to connect and authenticate with ScaleIO REST API, and use Invoke-RestMethod. In this article, I will explain how to query selected statistics/ properties with POST method. 

First, you have to define the set of properties that you would like to query, and then pass it to "invoke-restmethod". You can get the list of available properties of the respective object from the ScaleIO REST API Reference Guide. 

Example 1: Query and collect MDM cluster information
Here I am collecting the below-mentioned properties of "MDMCluster" object. 

#selected properties to query

$param1 = @'

{

    "properties":["name", "clusterMode", "master", "clusterState", "virtualIps"]

}

'@

#invoke-restmethod with respective uri

$MDM_cluster_stats = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/instances/System/queryMdmCluster " -Body $param1 -ContentType "application/json" -Headers $ScaleIOAuthHeaders -Method Post)

#organize output in a hash table

$mdm_props = @{

    'Cluster name'      = ($MDM_cluster_stats).name

    'Mode'              = ($MDM_cluster_stats).clusterMode

    'Cluster state'     = ($MDM_cluster_stats).clusterState

    'Master MDM IP'     = ($MDM_cluster_stats.master).managementIPs[0]

    'Cluster VIP01'     = ($MDM_cluster_stats).virtualIps[0]

    'Cluster VIP02'     = ($MDM_cluster_stats).virtualIps[1]

}

Write-Output $mdm_props

#sample output screenshot given below

Example 2: Query and collect overall ScaleIO system capacity details

Here I am collecting some properties of "System Statistics" object. 

#selected properties to query

$param2 = @'

{

    "properties":["maxCapacityInKb", "capacityInUseInKb", "spareCapacityInKb", "failedCapacityInKb", "degradedFailedCapacityInKb"]

}

'@

#invoke-restmethod with respective uri

$system_overall_stats = (Invoke-RestMethod -uri "https://192.168.11.15:443/api/types/System/instances/action/querySelectedStatistics " -Body $param2 -ContentType "application/json" -Headers $ScaleIOAuthHeaders -Method Post)

#organize output in a hash table

$system_capacity_props = @{

    "System max capacity (TB)"                = (($system_overall_stats.maxCapacityInKb)/1024/1024/1024)

    "System capacity in use (TB)"             = (($system_overall_stats.capacityInUseInKb)/1024/1024/1024)

    "System spare capacity (TB)"              = (($system_overall_stats.spareCapacityInKb)/1024/1024/1024)

    "System failed capacity (TB)"             = (($system_overall_stats.failedCapacityInKb)/1024/1024/1024)

    "System degraded failed capacity (TB)"    = (($system_overall_stats.degradedFailedCapacityInKb)/1024/1024/1024)

}

Write-Output $system_capacity_props

#sample output screenshot given below

Hope this was useful. Please refer Dell EMC ScaleIO Ready Node Version 2.5 API Reference Guide for more details.

Working with ScaleIO REST API using PowerShell - Part 1

In this article, I will explain briefly how to work with REST API exposed by ScaleIO software using PowerShell to manage/ monitor your ScaleIO system. ScaleIO can be deployed either using AMS (only for ScaleIO Ready Nodes) or without AMS. In case of an AMS deployment, API is available as part of the ScaleIO Ready Node AMS package. The AMS REST API is served from the AMS server which allows querying information and performing several actions related to ScaleIO Ready Node hardware and software components. For a non-AMS ScaleIO deployment, the REST API is served from the ScaleIO Gateway. If you used ScaleIO Installation Manager (IM) to install ScaleIO, the gateway has already been installed and configured with the MDM details. In both cases, the AMS server/ ScaleIO Gateway connects and queries master MDM, reformats the results in a RESTful manner and passes it to a REST client.

Here I am using an AMS managed ScaleIO Ready Node cluster. Access to the API requires a login using AMS username and password. Successful login returns a token, and you can use this token for later authentications for other requests. The responses or results returned by ScaleIO Ready Node AMS are in JSON format. In the following sections, I will explain how to use PowerShell to query ScaleIO REST API and obtain relevant results.  

PowerShell uses Invoke-RestMethod cmdlet which sends HTTP/ HTTPS requests to REST web services that return rich structured data. PowerShell will format the response based on the data type. For JSON PowerShell converts the response content to objects. 

Step 1: Authentication and token generation

#Note: 192.168.11.15 is the IP of my AMS server

$User = Read-Host -Prompt "Please enter ScaleIO AMS username"

$SecurePassword = Read-Host -Prompt "Enter ScaleIO Password for user $user" –AsSecureString

$Credentials = New-Object System.Management.Automation.PSCredential ($user,$Securepassword)

#HTTPS Get request is invoked with credentials for authentication

$Token = Invoke-RestMethod -Uri "https://192.168.11.15:443/api/login" -Method Get -Credential $Credentials

Step 2: Create header with the token

$auth = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes(':'+$Token))

$global:ScaleIOAuthHeaders = @{'Authorization' = "Basic $auth"

'Content-Type' = "application/json" }

Step 3: Invoke-RestMethod

#Query all alerts in the system

$alerts = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/types/Alert/instances/" -Method Get -Headers $ScaleIOAuthHeaders)

#Query all SDSs in a PD

$all_SDS = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/instances/ProtectionDomain::3ce4af5f00000000/relationships/Sds " -Method Get -Headers $ScaleIOAuthHeaders)

#Query a specified PD

$pd01 = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/instances/ProtectionDomain::3ce4af5f00000000 " -Method Get -Headers $ScaleIOAuthHeaders)

#Query statistics of a specified PD

$pd01_stats = (Invoke-RestMethod -Uri "https://192.168.11.15:443/api/instances/ProtectionDomain::3ce4af5f00000000/relationships/Statistics " -Method Get -Headers $ScaleIOAuthHeaders)

Hope this was useful. Refer to Dell EMC ScaleIO Ready Node Version 2.5 REST API Reference Guide for more details.

In the next article, I will explain how to query selected statistics/ parameters with POST method which will help you to

create custom monitoring scripts for your ScaleIO Ready Node environment.

Note:

If you are getting the below error while trying to create the token during step 1, please add the below lines of code to the

start of your script.

"Invoke-RestMethod : The underlying connection was closed: An unexpected error occurred on a send."

#Solution to above error!

add-type @"

    using System.Net;

    using System.Security.Cryptography.X509Certificates;

    public class TrustAllCertsPolicy : ICertificatePolicy {

        public bool CheckValidationResult(

            ServicePoint srvPoint, X509Certificate certificate,

            WebRequest request, int certificateProblem) {

            return true;

        }

    }

"@

[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy

[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12 -bor [System.Net.SecurityProtocolType]::Tls11

References:

Dell EMC ScaleIO Ready Node 14G 

Microsoft

bottkars/SIORestToolkit

Working with ScaleIO REST API using PowerShell - Part 2