Get HPOVScmbCertificates - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVScmbCertificates

Get State Change Message Bus certificates.

SYNTAX

Get-HPOVScmbCertificates [-Location] <String>[ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]
Get-HPOVScmbCertificates [-Password] <SecureString> [-Location] <String>[ [-ConvertToPFx] <SwitchParameter>][ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]

Detailed Description

Retrieve and store the certificates necessary to register with the State Change Message Bus. The SCMB only supports a single read-only "account".

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-ConvertToPFx <SwitchParameter>

Aliases [-pfx] Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.

Aliases pfx
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-InstallApplianceRootCA <SwitchParameter>

hoose to install the appliance root certificate to the current users Trusted Root Authorities store.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Location <String>

Aliases [-Save] Directory to store the SSL certificates. If the directory doesn"t exist, it will be created.

Aliases save
Required? true
Position? named
Default value ($pwd).path
Accept pipeline input? false
Accept wildcard characters?    False

-Password <SecureString>

Password that will be used to encrypt the PFX client certificate.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

SecureString

Password for PFX file

Return Values

3 files will be created:

  • {ApplianceConnection_Name}_ca.cer - Appliance internal Root Certificate Authority
  • {ApplianceConnection_Name}_cert.cer - Appliance managed rabbitmq_readonly user Public Key
  • {ApplianceConnection_Name}_privateKey.key - Appliance managed rabbitmq_readonly user Client Certificate

Pkcs12/PFX certificate file

If ConvertToPfX is used, the Pkcs12/PFX compliant certificate file is created, {ApplianceConnection_Name}_privateKey.pfx

Examples

 -------------------------- EXAMPLE 1 --------------------------

Get-HPOVScmbCertificates

Get the HPE OneView appliance SCMB SSL certificates, and save them in the current directory.

 -------------------------- EXAMPLE 2 --------------------------

read-host "Password" -AsSecureString | Get-HPOVScmbCertificates -Location C:\scmbcerts -ExportToPfx

Prompt for secure password input and pipe the value to Get-HPOVScmbCertificates to convert the cert.pem to PFX format with the pipeline secure password.

Related Links


Top

HPE OneView 4.00 Library

Get-HPOVScmbCertificates

Get State Change Message Bus certificates.

SYNTAX

Get-HPOVScmbCertificates [-Location] <String>[ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]
Get-HPOVScmbCertificates [-Password] <SecureString> [-Location] <String>[ [-ConvertToPFx] <SwitchParameter>][ [-InstallApplianceRootCA] <SwitchParameter>] [-ApplianceConnection] <Array> [<CommonParameters>]

Detailed Description

Retrieve and store the certificates necessary to register with the State Change Message Bus. The SCMB only supports a single read-only "account".

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-ConvertToPFx <SwitchParameter>

Aliases [-pfx] Convert rabbitmq_readonly client certificate to PFX format for .Net consumption.

Aliases pfx
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-InstallApplianceRootCA <SwitchParameter>

hoose to install the appliance root certificate to the current users Trusted Root Authorities store.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Location <String>

Aliases [-Save] Directory to store the SSL certificates. If the directory doesn't exist, it will be created.

Aliases save
Required? true
Position? named
Default value ($pwd).path
Accept pipeline input? false
Accept wildcard characters?    False

-Password <SecureString>

Password that will be used to encrypt the PFX client certificate.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

SecureString

Password for PFX file

Return Values

3 files will be created:

  • {ApplianceConnection_Name}_ca.cer - Appliance internal Root Certificate Authority
  • {ApplianceConnection_Name}_cert.cer - Appliance managed rabbitmq_readonly user Public Key
  • {ApplianceConnection_Name}_privateKey.key - Appliance managed rabbitmq_readonly user Client Certificate

Pkcs12/PFX certificate file

If ConvertToPfX is used, the Pkcs12/PFX compliant certificate file is created, {ApplianceConnection_Name}_privateKey.pfx

Examples

 -------------------------- EXAMPLE 1 --------------------------

Get-HPOVScmbCertificates

Get the HPE OneView appliance SCMB SSL certificates, and save them in the current directory.

 -------------------------- EXAMPLE 2 --------------------------

read-host 'Password' -AsSecureString | Get-HPOVScmbCertificates -Location C:\scmbcerts -ExportToPfx

Prompt for secure password input and pipe the value to Get-HPOVScmbCertificates to convert the cert.pem to PFX format with the pipeline secure password.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️