Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListManagementAgentsRequest

example

Click here to see how to use ListManagementAgentsRequest.

Properties

Optional accessLevel

accessLevel: undefined | string

When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.

Optional availabilityStatus

availabilityStatus: model.AvailabilityStatus

Filter to return only Management Agents in the particular availability status.

compartmentId

compartmentId: string

The OCID of the compartment to which a request will be scoped.

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.

Optional dataSourceName

dataSourceName: Array<string>

Unique name of the dataSource.

Optional dataSourceType

dataSourceType: model.DataSourceTypes

The type of the dataSource.

Optional displayName

displayName: undefined | string

Filter to return only Management Agents having the particular display name.

Optional gatewayId

gatewayId: Array<string>

Filter to return only results having the particular gatewayId.

Optional hostId

hostId: undefined | string

Filter to return only Management Agents having the particular agent host id.

Optional installType

installType: model.InstallTypes

A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.

Optional isCustomerDeployed

isCustomerDeployed: undefined | false | true

true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.

Optional lifecycleState

lifecycleState: model.LifecycleStates

Filter to return only Management Agents in the particular lifecycle state.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

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

Optional platformType

platformType: Array<PlatformTypes>

Filter to return only results having the particular platform type.

Optional pluginName

pluginName: Array<string>

Filter to return only Management Agents having the particular Plugin installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: 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. If no value is specified timeCreated is default.

Optional sortOrder

sortOrder: SortOrder

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

Optional version

version: Array<string>

Filter to return only Management Agents having the particular agent version.