Show / Hide Table of Contents

Set-OCIClientConfig

SYNOPSIS

Interactive Cmdlet to generate oci config file.

SYNTAX

Set-OCIClientConfig [-ConfigPath <String>] [-ProfileName <String>] [-UserOCID <String>] [-TenancyOCID <String>] [-RegionID <String>] [-KeyName <String>] [-KeyDirectory <String>] [-PassPhrase <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet helps create a new config file or setup a new profile in an existing config file. Config file will be created in the specified Config path 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

-ConfigPath

Path of the config file

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

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

-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

-ProfileName

Configuration profile name

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

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

-RegionID

User region ID

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

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

-TenancyOCID

Tenancy OCID

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

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

-UserOCID

User OCID

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