Get-OCIOpsiConfiguration

SYNOPSIS

Invokes OperationsInsights service - GetOpsiConfiguration operation.

SYNTAX

Default (Default)

Get-OCIOpsiConfiguration -OpsiConfigurationId <String> [-OpsiConfigField <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+OpsiConfigFieldEnum]>] [-ConfigItemCustomStatus <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemCustomStatusEnum]>] [-ConfigItemsApplicableContext <System.Collections.Generic.List`1[System.String]>] [-ConfigItemField <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemFieldEnum]>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

LifecycleStateParamSet

Get-OCIOpsiConfiguration -OpsiConfigurationId <String> [-OpsiConfigField <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+OpsiConfigFieldEnum]>] [-ConfigItemCustomStatus <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemCustomStatusEnum]>] [-ConfigItemsApplicableContext <System.Collections.Generic.List`1[System.String]>] [-ConfigItemField <System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemFieldEnum]>] [-OpcRequestId <String>] -WaitForLifecycleState <OpsiConfigurationLifecycleState[]> [-WaitIntervalSeconds <Int32>] [-MaxWaitAttempts <Int32>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets details of an OPSI configuration resource. Values specified in configItemField and configItemCustomStatus query params will be considered, only if configItems field is requested as part of opsiConfigField query param. Values specified in configItemCustomStatus will determine whether only customized configuration items or only non-customized configuration items or both have to be returned.

PARAMETERS

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

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

-ConfigFile

The path to 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

-ConfigItemCustomStatus

Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned.

Type: System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemCustomStatusEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Customized, NonCustomized

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigItemField

Specifies the fields to return in a config item summary.

Type: System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+ConfigItemFieldEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Name, Value, DefaultValue, Metadata, ApplicableContexts

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigItemsApplicableContext

Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MaxWaitAttempts

Maximum number of attempts to be made until the resource reaches a desired state.

Type: Int32
Parameter Sets: LifecycleStateParamSet
Aliases: None

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

-NoRetry

Disable retry logic for calls to services.

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

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

-OpcRequestId

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OpsiConfigField

Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default.

Type: System.Collections.Generic.List`1[Oci.OpsiService.Requests.GetOpsiConfigurationRequest+OpsiConfigFieldEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: ConfigItems

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OpsiConfigurationId

OCID of OPSI configuration resource.

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

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

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

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

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

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

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

-WaitForLifecycleState

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state.

Type: OpsiConfigurationLifecycleState[]
Parameter Sets: LifecycleStateParamSet
Aliases: None
Accepted values: UnknownEnumValue, Creating, Updating, Active, Deleting, Deleted, Failed

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

-WaitIntervalSeconds

Check every WaitIntervalSeconds to see whether the resource has reached a desired state.

Type: Int32
Parameter Sets: LifecycleStateParamSet
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

• Oci.OpsiService.Models.OpsiConfiguration
• Oci.OpsiService.Responses.GetOpsiConfigurationResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples