< Back
Get-HPERedfishSchema
Post
NAME Get-HPERedfishSchema
SYNOPSIS
Retrieve schema for the specified Type.
SYNTAX
Get-HPERedfishSchema [-odatatype] <String> [[-Session] <PSObject>] [[-Language] <String>]
[-DisableCertificateAuthentication] [<CommonParameters>]
DESCRIPTION
Retrieves the schema for the specified Type of Redfish data. The cmdlet first gets the JSON link of the schema and
then gets the data from the schema store that has the schema.
PARAMETERS
-odatatype <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Session <PSObject>
Session PSObject returned by executing Connect-HPERedfish cmdlet. It must have RootURI and X-Auth-Token for
executing this cmdlet.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Language <String>
The language code of the schema to be retrieved. The default value is 'en'. The allowed values depend on the
languages available on the system.
Required? false
Position? 3
Default value en
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DisableCertificateAuthentication [<SwitchParameter>]
If this switch parameter is present then server certificate authentication is disabled for the execution of
this cmdlet. If not present it will execute according to the global certificate authentication setting. The
default is to authenticate server certificates. See Enable-HPERedfishCertificateAuthentication and
Disable-HPERedfishCertificateAuthentication to set the per PowerShell session default.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe the Type parameter to Get-HPERedfishSchema.
OUTPUTS
System.Management.Automation.PSCustomObject
Get-HPERedfishSchema returns a PSCustomObject that has the retrieved schema of the specified type.
NOTES
See typical usage examples in the HPERedfishExamples.ps1 file installed with this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$sch = Get-HPERedfishSchema -odataType '#ComputerSystem.1.1.0.ComputerSystem' -Session $s
PS C:\\> $sch
$schema : http://json-schema.org/draft-04/schema#
title : ComputerSystem.1.1.0
type : object
readonly : False
additionalProperties : False
description : The schema definition of a computer system and its properties. A computer system represents
a physical or virtual machine and the local resources, such as memory, CPU, and other devices that can be accessed
from that machine.
properties : @{Oem=; Name=; Modified=; Type=; SystemType=; AssetTag=; Manufacturer=; Model=; SKU=;
SerialNumber=; Version=; PartNumber=; Description=; VirtualSerialNumber=; UUID=; HostCorrelation=; HostName=;
Status=; BIOSPOSTCode=; IndicatorLED=; Power=; PowerState=; Boot=; Bios=; BiosVersion=; Processors=;
ProcessorSummary=; Memory=; MemorySummary=; AvailableActions=; @odata.id=; @odata.context=; @odata.type=; Id=;
Actions=; LogServices=; Links=}
actions : @{description=The POST custom actions defined for this type (the implemented actions might
be a subset of these).; actions=}
copyright : Copyright 2014,2015 ABC Company Development, LP. Portions Copyright 2014-2015 Distributed
Management Task Force. All rights reserved.
PS C:\\> $sch.properties
Oem : @{type=object; readonly=False; additionalProperties=True; properties=}
Name : @{$ref=Resource.json#/definitions/Name}
Modified : @{$ref=Resource.json#/definitions/Modified}
Status : @{$ref=Resource.json#/definitions/Status}
BIOSPOSTCode : @{type=System.Object[]; description=The BIOS Power on Self Test code from the last system
boot.; readonly=True; etag=True; redfish=False; deprecated=This property has been deprecated.; replacedBy=}
IndicatorLED : @{type=System.Object[]; description=The state of the indicator LED.; enum=System.Object[];
enumDescriptions=; readonly=False; etag=True}
.
.
.
Power : @{type=System.Object[]; description=The current power state of the system.;
enum=System.Object[]; readonly=True; etag=True; redfish=False; deprecated=This property has been deprecated.;
replacedBy=PowerState}
ProcessorSummary : @{type=object; additionalProperties=False; properties=; description=This object describes
the central processors of the system in general detail.}
AvailableActions : @{type=array; readonly=True; additionalItems=False; uniqueItems=True; items=; redfish=False;
deprecated=The AvailableActions object has been deprecated and replaced by the Redfish compatible Actions object.;
replacedBy=Actions}
@odata.id : @{$ref=Resource.json#/definitions/odataid}
@odata.context : @{$ref=Resource.json#/definitions/odatacontext}
@odata.type : @{$ref=Resource.json#/definitions/odatatype}
Id : @{$ref=Resource.json#/definitions/Id}
Actions : @{additionalProperties=False; type=object; properties=}
LogServices : @{description=The LogService collection URI for this resource.; readonly=True; etag=False;
type=object; properties=}
Links : @{additionalProperties=True; readonly=True; type=object; properties=; description=The links
array contains the related resource URIs.}
PS C:\\> $sch.properties.IndicatorLED
type : {string, null}
description : The state of the indicator LED.
enum : {$null, Unknown, Lit, Blinking...}
enumDescriptions : @{Unknown=The state of the Indicator LED cannot be determined.; Lit=The
Indicator LED is lit.; Blinking=The Indicator LED is blinking.; Off=The
Indicator LED is off.}
readonly : False
etag : True
This example shows schema for @odata.type value '#ComputerSystem.1.1.0.ComputerSystem'.
RELATED LINKS
http://www.hpe.com/servers/powershell
SYNOPSIS
Retrieve schema for the specified Type.
SYNTAX
Get-HPERedfishSchema [-odatatype] <String> [[-Session] <PSObject>] [[-Language] <String>]
[-DisableCertificateAuthentication] [<CommonParameters>]
DESCRIPTION
Retrieves the schema for the specified Type of Redfish data. The cmdlet first gets the JSON link of the schema and
then gets the data from the schema store that has the schema.
PARAMETERS
-odatatype <String>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Session <PSObject>
Session PSObject returned by executing Connect-HPERedfish cmdlet. It must have RootURI and X-Auth-Token for
executing this cmdlet.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Language <String>
The language code of the schema to be retrieved. The default value is 'en'. The allowed values depend on the
languages available on the system.
Required? false
Position? 3
Default value en
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-DisableCertificateAuthentication [<SwitchParameter>]
If this switch parameter is present then server certificate authentication is disabled for the execution of
this cmdlet. If not present it will execute according to the global certificate authentication setting. The
default is to authenticate server certificates. See Enable-HPERedfishCertificateAuthentication and
Disable-HPERedfishCertificateAuthentication to set the per PowerShell session default.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe the Type parameter to Get-HPERedfishSchema.
OUTPUTS
System.Management.Automation.PSCustomObject
Get-HPERedfishSchema returns a PSCustomObject that has the retrieved schema of the specified type.
NOTES
See typical usage examples in the HPERedfishExamples.ps1 file installed with this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$sch = Get-HPERedfishSchema -odataType '#ComputerSystem.1.1.0.ComputerSystem' -Session $s
PS C:\\> $sch
$schema : http://json-schema.org/draft-04/schema#
title : ComputerSystem.1.1.0
type : object
readonly : False
additionalProperties : False
description : The schema definition of a computer system and its properties. A computer system represents
a physical or virtual machine and the local resources, such as memory, CPU, and other devices that can be accessed
from that machine.
properties : @{Oem=; Name=; Modified=; Type=; SystemType=; AssetTag=; Manufacturer=; Model=; SKU=;
SerialNumber=; Version=; PartNumber=; Description=; VirtualSerialNumber=; UUID=; HostCorrelation=; HostName=;
Status=; BIOSPOSTCode=; IndicatorLED=; Power=; PowerState=; Boot=; Bios=; BiosVersion=; Processors=;
ProcessorSummary=; Memory=; MemorySummary=; AvailableActions=; @odata.id=; @odata.context=; @odata.type=; Id=;
Actions=; LogServices=; Links=}
actions : @{description=The POST custom actions defined for this type (the implemented actions might
be a subset of these).; actions=}
copyright : Copyright 2014,2015 ABC Company Development, LP. Portions Copyright 2014-2015 Distributed
Management Task Force. All rights reserved.
PS C:\\> $sch.properties
Oem : @{type=object; readonly=False; additionalProperties=True; properties=}
Name : @{$ref=Resource.json#/definitions/Name}
Modified : @{$ref=Resource.json#/definitions/Modified}
Status : @{$ref=Resource.json#/definitions/Status}
BIOSPOSTCode : @{type=System.Object[]; description=The BIOS Power on Self Test code from the last system
boot.; readonly=True; etag=True; redfish=False; deprecated=This property has been deprecated.; replacedBy=}
IndicatorLED : @{type=System.Object[]; description=The state of the indicator LED.; enum=System.Object[];
enumDescriptions=; readonly=False; etag=True}
.
.
.
Power : @{type=System.Object[]; description=The current power state of the system.;
enum=System.Object[]; readonly=True; etag=True; redfish=False; deprecated=This property has been deprecated.;
replacedBy=PowerState}
ProcessorSummary : @{type=object; additionalProperties=False; properties=; description=This object describes
the central processors of the system in general detail.}
AvailableActions : @{type=array; readonly=True; additionalItems=False; uniqueItems=True; items=; redfish=False;
deprecated=The AvailableActions object has been deprecated and replaced by the Redfish compatible Actions object.;
replacedBy=Actions}
@odata.id : @{$ref=Resource.json#/definitions/odataid}
@odata.context : @{$ref=Resource.json#/definitions/odatacontext}
@odata.type : @{$ref=Resource.json#/definitions/odatatype}
Id : @{$ref=Resource.json#/definitions/Id}
Actions : @{additionalProperties=False; type=object; properties=}
LogServices : @{description=The LogService collection URI for this resource.; readonly=True; etag=False;
type=object; properties=}
Links : @{additionalProperties=True; readonly=True; type=object; properties=; description=The links
array contains the related resource URIs.}
PS C:\\> $sch.properties.IndicatorLED
type : {string, null}
description : The state of the indicator LED.
enum : {$null, Unknown, Lit, Blinking...}
enumDescriptions : @{Unknown=The state of the Indicator LED cannot be determined.; Lit=The
Indicator LED is lit.; Blinking=The Indicator LED is blinking.; Off=The
Indicator LED is off.}
readonly : False
etag : True
This example shows schema for @odata.type value '#ComputerSystem.1.1.0.ComputerSystem'.
RELATED LINKS
http://www.hpe.com/servers/powershell