< Back
Get-HPERedfishSchemaExtref
Post
NAME Get-HPERedfishSchemaExtref
SYNOPSIS
Retrieves the uri of the JSON file that contains the schema for the specified odata type.
SYNTAX
Get-HPERedfishSchemaExtref [-odatatype] <String> [[-Session] <PSObject>] [[-Language] <String>]
[-DisableCertificateAuthentication] [<CommonParameters>]
DESCRIPTION
Schema JSON file is pointed to by a uri. This link is retrieved from the external reference (extref) in Location
field of the @odata.type in /redfish/v1/schemas/. This is uri of the JSON file that contains the schema for the
specified type. This cmdlet retrieves this URI that points to the JSON schema file.
PARAMETERS
-odatatype <String>
Odata type value of the data for which schema JSON file link has to be retrieved. The odata type value is
present in the Redfish data as the value for the property '@odata.type'.
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 for which the JSON URI is 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-HPERedfishSchemaExtref.
OUTPUTS
System.String
Get-HPERedfishSchemaExtref returns a String that has the Extref of the schema specified by the Type parameter.
NOTES
See typical usage examples in the HPERedfishExamples.ps1 file installed with this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$schemaJSONodataid = Get-HPERedfishSchemaExtref -odatatype '#ComputerSystem.1.1.0.ComputerSystem' -Session
$s
PS C:\\> $schemaJSONodataid
/redfish/v1/SchemaStore/en/ComputerSystem.json/
This example shows that the schema for '#ComputerSystem.1.1.0.ComputerSystem' is stored at the external reference
/redfish/v1/SchemaStore/en/ComputerSystem.json/. The schema is retrieved using this as the value for 'Odataid'
parameter for Get-HPERedfishData or Get-HPERedfishDataRaw and navigate to the 'Properties' field.
RELATED LINKS
http://www.hpe.com/servers/powershell
SYNOPSIS
Retrieves the uri of the JSON file that contains the schema for the specified odata type.
SYNTAX
Get-HPERedfishSchemaExtref [-odatatype] <String> [[-Session] <PSObject>] [[-Language] <String>]
[-DisableCertificateAuthentication] [<CommonParameters>]
DESCRIPTION
Schema JSON file is pointed to by a uri. This link is retrieved from the external reference (extref) in Location
field of the @odata.type in /redfish/v1/schemas/. This is uri of the JSON file that contains the schema for the
specified type. This cmdlet retrieves this URI that points to the JSON schema file.
PARAMETERS
-odatatype <String>
Odata type value of the data for which schema JSON file link has to be retrieved. The odata type value is
present in the Redfish data as the value for the property '@odata.type'.
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 for which the JSON URI is 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-HPERedfishSchemaExtref.
OUTPUTS
System.String
Get-HPERedfishSchemaExtref returns a String that has the Extref of the schema specified by the Type parameter.
NOTES
See typical usage examples in the HPERedfishExamples.ps1 file installed with this module.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$schemaJSONodataid = Get-HPERedfishSchemaExtref -odatatype '#ComputerSystem.1.1.0.ComputerSystem' -Session
$s
PS C:\\> $schemaJSONodataid
/redfish/v1/SchemaStore/en/ComputerSystem.json/
This example shows that the schema for '#ComputerSystem.1.1.0.ComputerSystem' is stored at the external reference
/redfish/v1/SchemaStore/en/ComputerSystem.json/. The schema is retrieved using this as the value for 'Odataid'
parameter for Get-HPERedfishData or Get-HPERedfishDataRaw and navigate to the 'Properties' field.
RELATED LINKS
http://www.hpe.com/servers/powershell