Class ListManagementAgentsRequest
Implements
Inherited Members
Namespace: Oci.ManagementagentService.Requests
Assembly: OCI.DotNetSDK.Managementagent.dll
Syntax
public class ListManagementAgentsRequest : IOciRequest
Examples
Click here to see an example of how to use ListManagementAgents request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public string AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
string | When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request. |
AvailabilityStatus
Declaration
[HttpConverter(TargetEnum.Query, "availabilityStatus")]
public AvailabilityStatus? AvailabilityStatus { get; set; }
Property Value
Type | Description |
---|---|
AvailabilityStatus? | Filter to return only Management Agents in the particular availability status. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment to which a request will be scoped. |
Remarks
Required
CompartmentIdInSubtree
Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type | Description |
---|---|
bool? | if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified. |
DataSourceName
Declaration
[HttpConverter(TargetEnum.Query, "dataSourceName", CollectionFormatType.Multi)]
public List<string> DataSourceName { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Unique name of the dataSource. |
DataSourceType
Declaration
[HttpConverter(TargetEnum.Query, "dataSourceType")]
public DataSourceTypes? DataSourceType { get; set; }
Property Value
Type | Description |
---|---|
DataSourceTypes? | The type of the dataSource. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | Filter to return only Management Agents having the particular display name. |
GatewayId
Declaration
[HttpConverter(TargetEnum.Query, "gatewayId", CollectionFormatType.Multi)]
public List<string> GatewayId { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Filter to return only results having the particular gatewayId. |
HostId
Declaration
[HttpConverter(TargetEnum.Query, "hostId")]
public string HostId { get; set; }
Property Value
Type | Description |
---|---|
string | Filter to return only Management Agents having the particular agent host id. |
InstallType
Declaration
[HttpConverter(TargetEnum.Query, "installType")]
public InstallTypes? InstallType { get; set; }
Property Value
Type | Description |
---|---|
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. |
IsCustomerDeployed
Declaration
[HttpConverter(TargetEnum.Query, "isCustomerDeployed")]
public bool? IsCustomerDeployed { get; set; }
Property Value
Type | Description |
---|---|
bool? | true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleStates? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleStates? | Filter to return only Management Agents in the particular lifecycle state. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The client request ID for tracing. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
PlatformType
Declaration
[HttpConverter(TargetEnum.Query, "platformType", CollectionFormatType.Multi)]
public List<PlatformTypes> PlatformType { get; set; }
Property Value
Type | Description |
---|---|
List<PlatformTypes> | Filter to return only results having the particular platform type. |
PluginName
Declaration
[HttpConverter(TargetEnum.Query, "pluginName", CollectionFormatType.Multi)]
public List<string> PluginName { get; set; }
Property Value
Type | Description |
---|---|
List<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. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListManagementAgentsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListManagementAgentsRequest.SortByEnum? | 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. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListManagementAgentsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListManagementAgentsRequest.SortOrderEnum? | The sort order to use, either 'asc' or 'desc'. |
Version
Declaration
[HttpConverter(TargetEnum.Query, "version", CollectionFormatType.Multi)]
public List<string> Version { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Filter to return only Management Agents having the particular agent version. |