Get-OCIJmsPluginsList

SYNOPSIS

Invokes JavaManagementService service - ListJmsPlugins operation.

SYNTAX

Limit

Get-OCIJmsPluginsList [-CompartmentId <String>] [-CompartmentIdInSubtree <Boolean>] [-Id <String>] [-FleetId <String>] [-AgentId <String>] [-LifecycleState <JmsPluginLifecycleState>] [-AvailabilityStatus <JmsPluginAvailabilityStatus>] [-AgentType <AgentType>] [-TimeRegisteredLessThanOrEqualTo <DateTime>] [-TimeLastSeenLessThanOrEqualTo <DateTime>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <JmsPluginSortBy>] [-HostnameContains <String>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIJmsPluginsList [-CompartmentId <String>] [-CompartmentIdInSubtree <Boolean>] [-Id <String>] [-FleetId <String>] [-AgentId <String>] [-LifecycleState <JmsPluginLifecycleState>] [-AvailabilityStatus <JmsPluginAvailabilityStatus>] [-AgentType <AgentType>] [-TimeRegisteredLessThanOrEqualTo <DateTime>] [-TimeLastSeenLessThanOrEqualTo <DateTime>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <JmsPluginSortBy>] [-HostnameContains <String>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists the JmsPlugins.

PARAMETERS

-AgentId

The ManagementAgent (OMA), Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) OCID that identifies the Agent.

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

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

-AgentType

Filter JmsPlugin with agent type.

Type: AgentType
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Oma, Oca, Ocma

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

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

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

-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

-AvailabilityStatus

Filter JmsPlugin with its availability status.

Type: JmsPluginAvailabilityStatus
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Silent, NotAvailable

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

-CompartmentId

The OCID of the compartment in which to list resources.

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

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

-CompartmentIdInSubtree

Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-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

-FleetId

The ID of the Fleet.

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

-HostnameContains

Filter the list with hostname contains the given value.

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

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

-Id

The OCID of the JmsPlugin.

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

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

-LifecycleState

Filter JmsPlugin with its lifecycle state.

Type: JmsPluginLifecycleState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Inactive, NeedsAttention, Deleted

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

-Limit

The maximum number of items to return.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

The client request ID for tracing.

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

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

-Page

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

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

Required: False
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

-SortBy

The field to sort JmsPlugin. Only one sort order may be provided. Default order is descending. If no value is specified timeLastSeen is default.

Type: JmsPluginSortBy
Parameter Sets: (All)
Aliases: None
Accepted values: Id, TimeLastSeen, TimeRegistered, Hostname, AgentId, AgentType, LifecycleState, AvailabilityStatus, FleetId, CompartmentId, OsFamily, OsArchitecture, OsDistribution, PluginVersion

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

-SortOrder

The sort order, either 'asc' or 'desc'.

Type: SortOrder
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

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

-TimeLastSeenLessThanOrEqualTo

If present, only plugins with a last seen time before this parameter are searched (formatted according to RFC3339).

Type: DateTime
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

-TimeRegisteredLessThanOrEqualTo

If present, only plugins with a registration time before this parameter are searched (formatted according to RFC3339).

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

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.JmsService.Models.JmsPluginCollection
• Oci.JmsService.Responses.ListJmsPluginsResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples