Show / Hide Table of Contents

New-OCIClientKeys

SYNOPSIS

Creates a PEM formatted asymmetric cipher key pair.

SYNTAX

New-OCIClientKeys [-KeyName <String>] [-KeyDirectory <String>] [-PassPhrase <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet helps setup a new PEM formatted asymmetric RSA cipher key pair. Keys will be created in the specified Key Directory or the default .oci directory under user's home. This Cmdlet might prompt for user input if the cmdlet invocation doesn't contain a value for some parameters described below.

PARAMETERS

-KeyDirectory

An optional directory to output the generated keys.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyName

A name for the key. Generated key files will be {key-name}.pem and {key-name}_public.pem

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassPhrase

An optional passphrase to encrypt the private key.Specify "" to avoid encrypting the private key.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

  • System.Void

RELATED LINKS

  • OCIModulesDocs
  • Examples
Back to top Generated by DocFX