Show / Hide Table of Contents

Get-OCIOsmanagementhubScheduledJobsList

SYNOPSIS

Invokes ScheduledJob service - ListScheduledJobs operation.

SYNTAX

Limit

Get-OCIOsmanagementhubScheduledJobsList [-CompartmentId <String>] [-DisplayName <String>] [-DisplayNameContains <String>] [-LifecycleState <LifecycleStateEnum>] [-ManagedInstanceId <String>] [-ManagedInstanceGroupId <String>] [-ManagedCompartmentId <String>] [-LifecycleStageId <String>] [-OperationType <OperationTypes>] [-ScheduleType <ScheduleTypes>] [-TimeStart <DateTime>] [-TimeEnd <DateTime>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-IsRestricted <Boolean>] [-Id <String>] [-CompartmentIdInSubtree <Boolean>] [-Location <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-LocationNotEqualTo <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-IsManagedByAutonomousLinux <Boolean>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIOsmanagementhubScheduledJobsList [-CompartmentId <String>] [-DisplayName <String>] [-DisplayNameContains <String>] [-LifecycleState <LifecycleStateEnum>] [-ManagedInstanceId <String>] [-ManagedInstanceGroupId <String>] [-ManagedCompartmentId <String>] [-LifecycleStageId <String>] [-OperationType <OperationTypes>] [-ScheduleType <ScheduleTypes>] [-TimeStart <DateTime>] [-TimeEnd <DateTime>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-IsRestricted <Boolean>] [-Id <String>] [-CompartmentIdInSubtree <Boolean>] [-Location <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-LocationNotEqualTo <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-IsManagedByAutonomousLinux <Boolean>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists scheduled jobs that match the specified compartment or scheduled job OCID.

PARAMETERS

-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

-CompartmentId

The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.

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

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

-CompartmentIdInSubtree

Indicates whether to include subcompartments in the returned results. Default is false.

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

-DisplayName

A filter to return resources that match the given user-friendly name.

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

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

-DisplayNameContains

A filter to return resources that may partially match the given display name.

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

-Id

The OCID of the scheduled job. A filter to return the specified job.

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

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

-IsManagedByAutonomousLinux

Indicates whether to list only resources managed by the Autonomous Linux service.

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

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

-IsRestricted

A filter to return only restricted scheduled jobs.

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

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

-LifecycleStageId

The OCID of the lifecycle stage. This resource returns resources associated with this lifecycle stage.

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

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

-LifecycleState

A filter to return only scheduled jobs currently in the given state.

Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Creating, Updating, Active, Inactive, Deleting, Deleted, Failed

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

-Limit

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Example: `50`

Type: Int32
Parameter Sets: Limit
Aliases: None

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

-Location

A filter to return only resources whose location matches the given value.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, OnPremise, OciCompute, Azure, Ec2, Gcp

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

-LocationNotEqualTo

A filter to return only resources whose location does not match the given value.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, OnPremise, OciCompute, Azure, Ec2, Gcp

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

-ManagedCompartmentId

The OCID of the managed compartment. This filter returns resources associated with this compartment.

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

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

-ManagedInstanceGroupId

The OCID of the managed instance group. This filter returns resources associated with this group.

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

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

-ManagedInstanceId

The OCID of the managed instance. This filter returns resources associated with this managed instance.

Type: String
Parameter Sets: (All)
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

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

-OperationType

A filter to return only scheduled jobs with the given operation type.

Type: OperationTypes
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, InstallPackages, UpdatePackages, RemovePackages, UpdateAll, UpdateSecurity, UpdateBugfix, UpdateEnhancement, UpdateOther, UpdateKspliceUserspace, UpdateKspliceKernel, ManageModuleStreams, SwitchModuleStream, AttachSoftwareSources, DetachSoftwareSources, SyncManagementStationMirror, PromoteLifecycle, InstallWindowsUpdates, InstallAllWindowsUpdates, InstallSecurityWindowsUpdates, InstallBugfixWindowsUpdates, InstallEnhancementWindowsUpdates, InstallOtherWindowsUpdates, Reboot, RerunWorkRequest

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

-Page

For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Example: `3`

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

-ScheduleType

A filter to return only scheduled jobs of the given scheduling type (one-time or recurring).

Type: ScheduleTypes
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Onetime, Recurring

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

-SortBy

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: TimeCreated, DisplayName

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

-SortOrder

The sort order to use, 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

-TimeEnd

A filter to return only resources with a date on or before the given value, in ISO 8601 format.

Example: 2017-07-14T02:40:00.000Z

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

-TimeStart

A filter to return only resources with a date on or after the given value, in ISO 8601 format.

Example: 2017-07-14T02:40:00.000Z

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.OsmanagementhubService.Models.ScheduledJobCollection
  • Oci.OsmanagementhubService.Responses.ListScheduledJobsResponse

RELATED LINKS

  • APIReference
  • DotnetSDKAPI
  • OCIModulesDocs
  • OCIServiceConcepts
  • Examples
Back to top Generated by DocFX