Get-OCIOsmanagementhubManagedInstancesList

SYNOPSIS

Invokes ManagedInstance service - ListManagedInstances operation.

SYNTAX

Limit

Get-OCIOsmanagementhubManagedInstancesList [-CompartmentId <String>] [-DisplayName <System.Collections.Generic.List`1[System.String]>] [-DisplayNameContains <String>] [-ManagedInstanceId <String>] [-Status <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceStatus]>] [-ArchType <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ArchType]>] [-OsFamily <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OsFamily]>] [-IsManagementStation <Boolean>] [-Group <String>] [-GroupNotEqualTo <String>] [-LifecycleStage <String>] [-LifecycleStageNotEqualTo <String>] [-IsAttachedToGroupOrLifecycleStage <Boolean>] [-SoftwareSourceId <String>] [-AdvisoryName <System.Collections.Generic.List`1[System.String]>] [-LifecycleEnvironment <String>] [-LifecycleEnvironmentNotEqualTo <String>] [-Location <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-LocationNotEqualTo <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-OsmanagementhubProfile <System.Collections.Generic.List`1[System.String]>] [-ProfileNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-IsProfileAttached <Boolean>] [-IsManagedByAutonomousLinux <Boolean>] [-AgentVersion <String>] [-ManagementStation <System.Collections.Generic.List`1[System.String]>] [-ManagementStationNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-IsRebootRequired <Boolean>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIOsmanagementhubManagedInstancesList [-CompartmentId <String>] [-DisplayName <System.Collections.Generic.List`1[System.String]>] [-DisplayNameContains <String>] [-ManagedInstanceId <String>] [-Status <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceStatus]>] [-ArchType <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ArchType]>] [-OsFamily <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OsFamily]>] [-IsManagementStation <Boolean>] [-Group <String>] [-GroupNotEqualTo <String>] [-LifecycleStage <String>] [-LifecycleStageNotEqualTo <String>] [-IsAttachedToGroupOrLifecycleStage <Boolean>] [-SoftwareSourceId <String>] [-AdvisoryName <System.Collections.Generic.List`1[System.String]>] [-LifecycleEnvironment <String>] [-LifecycleEnvironmentNotEqualTo <String>] [-Location <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-LocationNotEqualTo <System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceLocation]>] [-OsmanagementhubProfile <System.Collections.Generic.List`1[System.String]>] [-ProfileNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-IsProfileAttached <Boolean>] [-IsManagedByAutonomousLinux <Boolean>] [-AgentVersion <String>] [-ManagementStation <System.Collections.Generic.List`1[System.String]>] [-ManagementStationNotEqualTo <System.Collections.Generic.List`1[System.String]>] [-IsRebootRequired <Boolean>] [-Page <String>] [-SortOrder <SortOrder>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version.

PARAMETERS

-AdvisoryName

The assigned erratum name. It's unique and not changeable.

Example: `ELSA-2020-5804`

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

-AgentVersion

A filter to return only managed instances with the specified version of osmh-agent running.

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

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

-ArchType

A filter to return only instances whose architecture type matches the given architecture.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ArchType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, X8664, Aarch64, I686, Noarch, Src, I386

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

-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 display names.

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

-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

-Group

A filter to return only managed instances that are attached to the specified group.

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

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

-GroupNotEqualTo

A filter to return only managed instances that are NOT attached to the specified group.

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

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

-IsAttachedToGroupOrLifecycleStage

A filter to return only managed instances that are attached to the specified group or lifecycle environment.

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

-IsManagementStation

A filter to return only managed instances that are acting as management stations.

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

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

-IsProfileAttached

A filter to return only managed instances with a registration profile attached.

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

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

-IsRebootRequired

A filter to return only managed instances that require a reboot to install updates.

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

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

-LifecycleEnvironment

A filter to return only managed instances in a specific lifecycle environment.

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

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

-LifecycleEnvironmentNotEqualTo

A filter to return only managed instances that aren't in a specific lifecycle environment.

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

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

-LifecycleStage

A filter to return only managed instances that are associated with the specified lifecycle environment.

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

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

-LifecycleStageNotEqualTo

A filter to return only managed instances that are NOT associated with the specified lifecycle environment.

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

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

-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

-ManagementStation

A filter to return resources that are associated with the specified management station OCIDs.

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

-ManagementStationNotEqualTo

A filter to return resources that aren't associated with the specified management station OCIDs.

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

-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

-OsFamily

A filter to return only resources that match the given operating system family.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.OsFamily]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, OracleLinux9, OracleLinux8, OracleLinux7, OracleLinux6, WindowsServer2016, WindowsServer2019, WindowsServer2022, All

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

-OsmanagementhubProfile

A multi filter to return only managed instances that match the given profile ids.This property corresponds to Profile parameter in the API.

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

-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

-ProfileNotEqualTo

A multi filter to return only managed instances that don't contain the given profile OCIDs.

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

-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

-SoftwareSourceId

The OCID of the software source. This filter returns resources associated with this software source.

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

-Status

A filter to return only managed instances whose status matches the status provided.

Type: System.Collections.Generic.List`1[Oci.OsmanagementhubService.Models.ManagedInstanceStatus]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Normal, Unreachable, Error, Warning, RegistrationError, Deleting, Onboarding, Rebooting

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

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.ManagedInstanceCollection
• Oci.OsmanagementhubService.Responses.ListManagedInstancesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples