1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ManagementAgent
  5. getManagementAgents
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.ManagementAgent.getManagementAgents

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

This data source provides the list of Management Agents in Oracle Cloud Infrastructure Management Agent service.

Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testManagementAgents = oci.ManagementAgent.getManagementAgents({
    compartmentId: compartmentId,
    accessLevel: managementAgentAccessLevel,
    availabilityStatus: managementAgentAvailabilityStatus,
    compartmentIdInSubtree: managementAgentCompartmentIdInSubtree,
    dataSourceNames: testManagementAgentDataSource.name,
    dataSourceType: managementAgentDataSourceType,
    displayName: managementAgentDisplayName,
    gatewayIds: testGateway.id,
    hostId: testHost.id,
    waitForHostId: 10,
    installType: managementAgentInstallType,
    isCustomerDeployed: managementAgentIsCustomerDeployed,
    platformTypes: managementAgentPlatformType,
    pluginNames: managementAgentPluginName,
    state: managementAgentState,
    versions: managementAgentVersion,
});
Copy
import pulumi
import pulumi_oci as oci

test_management_agents = oci.ManagementAgent.get_management_agents(compartment_id=compartment_id,
    access_level=management_agent_access_level,
    availability_status=management_agent_availability_status,
    compartment_id_in_subtree=management_agent_compartment_id_in_subtree,
    data_source_names=test_management_agent_data_source["name"],
    data_source_type=management_agent_data_source_type,
    display_name=management_agent_display_name,
    gateway_ids=test_gateway["id"],
    host_id=test_host["id"],
    wait_for_host_id=10,
    install_type=management_agent_install_type,
    is_customer_deployed=management_agent_is_customer_deployed,
    platform_types=management_agent_platform_type,
    plugin_names=management_agent_plugin_name,
    state=management_agent_state,
    versions=management_agent_version)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/managementagent"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := managementagent.GetManagementAgents(ctx, &managementagent.GetManagementAgentsArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(managementAgentAccessLevel),
			AvailabilityStatus:     pulumi.StringRef(managementAgentAvailabilityStatus),
			CompartmentIdInSubtree: pulumi.BoolRef(managementAgentCompartmentIdInSubtree),
			DataSourceNames:        testManagementAgentDataSource.Name,
			DataSourceType:         pulumi.StringRef(managementAgentDataSourceType),
			DisplayName:            pulumi.StringRef(managementAgentDisplayName),
			GatewayIds:             testGateway.Id,
			HostId:                 pulumi.StringRef(testHost.Id),
			WaitForHostId:          pulumi.IntRef(10),
			InstallType:            pulumi.StringRef(managementAgentInstallType),
			IsCustomerDeployed:     pulumi.BoolRef(managementAgentIsCustomerDeployed),
			PlatformTypes:          managementAgentPlatformType,
			PluginNames:            managementAgentPluginName,
			State:                  pulumi.StringRef(managementAgentState),
			Versions:               managementAgentVersion,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testManagementAgents = Oci.ManagementAgent.GetManagementAgents.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = managementAgentAccessLevel,
        AvailabilityStatus = managementAgentAvailabilityStatus,
        CompartmentIdInSubtree = managementAgentCompartmentIdInSubtree,
        DataSourceNames = testManagementAgentDataSource.Name,
        DataSourceType = managementAgentDataSourceType,
        DisplayName = managementAgentDisplayName,
        GatewayIds = testGateway.Id,
        HostId = testHost.Id,
        WaitForHostId = 10,
        InstallType = managementAgentInstallType,
        IsCustomerDeployed = managementAgentIsCustomerDeployed,
        PlatformTypes = managementAgentPlatformType,
        PluginNames = managementAgentPluginName,
        State = managementAgentState,
        Versions = managementAgentVersion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ManagementAgent.ManagementAgentFunctions;
import com.pulumi.oci.ManagementAgent.inputs.GetManagementAgentsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testManagementAgents = ManagementAgentFunctions.getManagementAgents(GetManagementAgentsArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(managementAgentAccessLevel)
            .availabilityStatus(managementAgentAvailabilityStatus)
            .compartmentIdInSubtree(managementAgentCompartmentIdInSubtree)
            .dataSourceNames(testManagementAgentDataSource.name())
            .dataSourceType(managementAgentDataSourceType)
            .displayName(managementAgentDisplayName)
            .gatewayIds(testGateway.id())
            .hostId(testHost.id())
            .waitForHostId(10)
            .installType(managementAgentInstallType)
            .isCustomerDeployed(managementAgentIsCustomerDeployed)
            .platformTypes(managementAgentPlatformType)
            .pluginNames(managementAgentPluginName)
            .state(managementAgentState)
            .versions(managementAgentVersion)
            .build());

    }
}
Copy
variables:
  testManagementAgents:
    fn::invoke:
      function: oci:ManagementAgent:getManagementAgents
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${managementAgentAccessLevel}
        availabilityStatus: ${managementAgentAvailabilityStatus}
        compartmentIdInSubtree: ${managementAgentCompartmentIdInSubtree}
        dataSourceNames: ${testManagementAgentDataSource.name}
        dataSourceType: ${managementAgentDataSourceType}
        displayName: ${managementAgentDisplayName}
        gatewayIds: ${testGateway.id}
        hostId: ${testHost.id}
        waitForHostId: 10
        installType: ${managementAgentInstallType}
        isCustomerDeployed: ${managementAgentIsCustomerDeployed}
        platformTypes: ${managementAgentPlatformType}
        pluginNames: ${managementAgentPluginName}
        state: ${managementAgentState}
        versions: ${managementAgentVersion}
Copy

Using getManagementAgents

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getManagementAgents(args: GetManagementAgentsArgs, opts?: InvokeOptions): Promise<GetManagementAgentsResult>
function getManagementAgentsOutput(args: GetManagementAgentsOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentsResult>
Copy
def get_management_agents(access_level: Optional[str] = None,
                          availability_status: Optional[str] = None,
                          compartment_id: Optional[str] = None,
                          compartment_id_in_subtree: Optional[bool] = None,
                          data_source_names: Optional[Sequence[str]] = None,
                          data_source_type: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_managementagent.GetManagementAgentsFilter]] = None,
                          gateway_ids: Optional[Sequence[str]] = None,
                          host_id: Optional[str] = None,
                          install_type: Optional[str] = None,
                          is_customer_deployed: Optional[bool] = None,
                          platform_types: Optional[Sequence[str]] = None,
                          plugin_names: Optional[Sequence[str]] = None,
                          state: Optional[str] = None,
                          versions: Optional[Sequence[str]] = None,
                          wait_for_host_id: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetManagementAgentsResult
def get_management_agents_output(access_level: Optional[pulumi.Input[str]] = None,
                          availability_status: Optional[pulumi.Input[str]] = None,
                          compartment_id: Optional[pulumi.Input[str]] = None,
                          compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                          data_source_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          data_source_type: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_managementagent.GetManagementAgentsFilterArgs]]]] = None,
                          gateway_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          host_id: Optional[pulumi.Input[str]] = None,
                          install_type: Optional[pulumi.Input[str]] = None,
                          is_customer_deployed: Optional[pulumi.Input[bool]] = None,
                          platform_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          plugin_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          versions: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                          wait_for_host_id: Optional[pulumi.Input[int]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentsResult]
Copy
func GetManagementAgents(ctx *Context, args *GetManagementAgentsArgs, opts ...InvokeOption) (*GetManagementAgentsResult, error)
func GetManagementAgentsOutput(ctx *Context, args *GetManagementAgentsOutputArgs, opts ...InvokeOption) GetManagementAgentsResultOutput
Copy

> Note: This function is named GetManagementAgents in the Go SDK.

public static class GetManagementAgents 
{
    public static Task<GetManagementAgentsResult> InvokeAsync(GetManagementAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentsResult> Invoke(GetManagementAgentsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagementAgentsResult> getManagementAgents(GetManagementAgentsArgs args, InvokeOptions options)
public static Output<GetManagementAgentsResult> getManagementAgents(GetManagementAgentsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:ManagementAgent/getManagementAgents:getManagementAgents
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
AccessLevel string
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
AvailabilityStatus string
Filter to return only Management Agents in the particular availability status.
CompartmentIdInSubtree bool
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
DataSourceNames List<string>
Unique name of the dataSource.
DataSourceType string
The type of the dataSource.
DisplayName string
Filter to return only Management Agents having the particular display name.
Filters Changes to this property will trigger replacement. List<GetManagementAgentsFilter>
GatewayIds List<string>
Filter to return only results having the particular gatewayId.
HostId string
Filter to return only Management Agents having the particular agent host id.
InstallType string
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 bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
PlatformTypes List<string>
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
PluginNames List<string>
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
State string
Filter to return only Management Agents in the particular lifecycle state.
Versions List<string>
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
WaitForHostId int
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.
CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
AccessLevel string
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
AvailabilityStatus string
Filter to return only Management Agents in the particular availability status.
CompartmentIdInSubtree bool
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
DataSourceNames []string
Unique name of the dataSource.
DataSourceType string
The type of the dataSource.
DisplayName string
Filter to return only Management Agents having the particular display name.
Filters Changes to this property will trigger replacement. []GetManagementAgentsFilter
GatewayIds []string
Filter to return only results having the particular gatewayId.
HostId string
Filter to return only Management Agents having the particular agent host id.
InstallType string
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 bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
PlatformTypes []string
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
PluginNames []string
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
State string
Filter to return only Management Agents in the particular lifecycle state.
Versions []string
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
WaitForHostId int
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
accessLevel String
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
availabilityStatus String
Filter to return only Management Agents in the particular availability status.
compartmentIdInSubtree Boolean
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
dataSourceNames List<String>
Unique name of the dataSource.
dataSourceType String
The type of the dataSource.
displayName String
Filter to return only Management Agents having the particular display name.
filters Changes to this property will trigger replacement. List<GetsFilter>
gatewayIds List<String>
Filter to return only results having the particular gatewayId.
hostId String
Filter to return only Management Agents having the particular agent host id.
installType String
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 Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes List<String>
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
pluginNames List<String>
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
state String
Filter to return only Management Agents in the particular lifecycle state.
versions List<String>
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
waitForHostId Integer
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.
compartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
accessLevel string
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
availabilityStatus string
Filter to return only Management Agents in the particular availability status.
compartmentIdInSubtree boolean
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
dataSourceNames string[]
Unique name of the dataSource.
dataSourceType string
The type of the dataSource.
displayName string
Filter to return only Management Agents having the particular display name.
filters Changes to this property will trigger replacement. GetManagementAgentsFilter[]
gatewayIds string[]
Filter to return only results having the particular gatewayId.
hostId string
Filter to return only Management Agents having the particular agent host id.
installType string
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 boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes string[]
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
pluginNames string[]
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
state string
Filter to return only Management Agents in the particular lifecycle state.
versions string[]
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
waitForHostId number
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.
compartment_id This property is required. str
The OCID of the compartment to which a request will be scoped.
access_level str
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
availability_status str
Filter to return only Management Agents in the particular availability status.
compartment_id_in_subtree bool
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
data_source_names Sequence[str]
Unique name of the dataSource.
data_source_type str
The type of the dataSource.
display_name str
Filter to return only Management Agents having the particular display name.
filters Changes to this property will trigger replacement. Sequence[managementagent.GetManagementAgentsFilter]
gateway_ids Sequence[str]
Filter to return only results having the particular gatewayId.
host_id str
Filter to return only Management Agents having the particular agent host id.
install_type str
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
is_customer_deployed bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platform_types Sequence[str]
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
plugin_names Sequence[str]
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
state str
Filter to return only Management Agents in the particular lifecycle state.
versions Sequence[str]
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
wait_for_host_id int
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
accessLevel String
When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
availabilityStatus String
Filter to return only Management Agents in the particular availability status.
compartmentIdInSubtree Boolean
if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
dataSourceNames List<String>
Unique name of the dataSource.
dataSourceType String
The type of the dataSource.
displayName String
Filter to return only Management Agents having the particular display name.
filters Changes to this property will trigger replacement. List<Property Map>
gatewayIds List<String>
Filter to return only results having the particular gatewayId.
hostId String
Filter to return only Management Agents having the particular agent host id.
installType String
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 Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes List<String>
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
pluginNames List<String>
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
state String
Filter to return only Management Agents in the particular lifecycle state.
versions List<String>
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
waitForHostId Number
When host_id argument is set, the data source will wait for the given period of time (in minutes) for this host_id to become available. This can be used when compute instance with Management Agent has been recently created.

getManagementAgents Result

The following output properties are available:

CompartmentId string
Compartment Identifier
Id string
The provider-assigned unique ID for this managed resource.
ManagementAgents List<GetManagementAgentsManagementAgent>
The list of management_agents.
AccessLevel string
AvailabilityStatus string
The current availability status of managementAgent
CompartmentIdInSubtree bool
DataSourceNames List<string>
DataSourceType string
DisplayName string
Management Agent Name
Filters List<GetManagementAgentsFilter>
GatewayIds List<string>
HostId string
Host resource ocid
InstallType string
The install type, either AGENT or GATEWAY
IsCustomerDeployed bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
PlatformTypes List<string>
Platform Type
PluginNames List<string>
Management Agent Plugin Name
State string
The current state of managementAgent
Versions List<string>
Management Agent Version
WaitForHostId int
CompartmentId string
Compartment Identifier
Id string
The provider-assigned unique ID for this managed resource.
ManagementAgents []GetManagementAgentsManagementAgent
The list of management_agents.
AccessLevel string
AvailabilityStatus string
The current availability status of managementAgent
CompartmentIdInSubtree bool
DataSourceNames []string
DataSourceType string
DisplayName string
Management Agent Name
Filters []GetManagementAgentsFilter
GatewayIds []string
HostId string
Host resource ocid
InstallType string
The install type, either AGENT or GATEWAY
IsCustomerDeployed bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
PlatformTypes []string
Platform Type
PluginNames []string
Management Agent Plugin Name
State string
The current state of managementAgent
Versions []string
Management Agent Version
WaitForHostId int
compartmentId String
Compartment Identifier
id String
The provider-assigned unique ID for this managed resource.
managementAgents List<Gets>
The list of management_agents.
accessLevel String
availabilityStatus String
The current availability status of managementAgent
compartmentIdInSubtree Boolean
dataSourceNames List<String>
dataSourceType String
displayName String
Management Agent Name
filters List<GetsFilter>
gatewayIds List<String>
hostId String
Host resource ocid
installType String
The install type, either AGENT or GATEWAY
isCustomerDeployed Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes List<String>
Platform Type
pluginNames List<String>
Management Agent Plugin Name
state String
The current state of managementAgent
versions List<String>
Management Agent Version
waitForHostId Integer
compartmentId string
Compartment Identifier
id string
The provider-assigned unique ID for this managed resource.
managementAgents GetManagementAgentsManagementAgent[]
The list of management_agents.
accessLevel string
availabilityStatus string
The current availability status of managementAgent
compartmentIdInSubtree boolean
dataSourceNames string[]
dataSourceType string
displayName string
Management Agent Name
filters GetManagementAgentsFilter[]
gatewayIds string[]
hostId string
Host resource ocid
installType string
The install type, either AGENT or GATEWAY
isCustomerDeployed boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes string[]
Platform Type
pluginNames string[]
Management Agent Plugin Name
state string
The current state of managementAgent
versions string[]
Management Agent Version
waitForHostId number
compartment_id str
Compartment Identifier
id str
The provider-assigned unique ID for this managed resource.
management_agents Sequence[managementagent.GetManagementAgentsManagementAgent]
The list of management_agents.
access_level str
availability_status str
The current availability status of managementAgent
compartment_id_in_subtree bool
data_source_names Sequence[str]
data_source_type str
display_name str
Management Agent Name
filters Sequence[managementagent.GetManagementAgentsFilter]
gateway_ids Sequence[str]
host_id str
Host resource ocid
install_type str
The install type, either AGENT or GATEWAY
is_customer_deployed bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platform_types Sequence[str]
Platform Type
plugin_names Sequence[str]
Management Agent Plugin Name
state str
The current state of managementAgent
versions Sequence[str]
Management Agent Version
wait_for_host_id int
compartmentId String
Compartment Identifier
id String
The provider-assigned unique ID for this managed resource.
managementAgents List<Property Map>
The list of management_agents.
accessLevel String
availabilityStatus String
The current availability status of managementAgent
compartmentIdInSubtree Boolean
dataSourceNames List<String>
dataSourceType String
displayName String
Management Agent Name
filters List<Property Map>
gatewayIds List<String>
hostId String
Host resource ocid
installType String
The install type, either AGENT or GATEWAY
isCustomerDeployed Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
platformTypes List<String>
Platform Type
pluginNames List<String>
Management Agent Plugin Name
state String
The current state of managementAgent
versions List<String>
Management Agent Version
waitForHostId Number

Supporting Types

GetManagementAgentsFilter

Name This property is required. string
Name of the property
Values This property is required. List<string>
Values of the property
Regex bool
Name This property is required. string
Name of the property
Values This property is required. []string
Values of the property
Regex bool
name This property is required. String
Name of the property
values This property is required. List<String>
Values of the property
regex Boolean
name This property is required. string
Name of the property
values This property is required. string[]
Values of the property
regex boolean
name This property is required. str
Name of the property
values This property is required. Sequence[str]
Values of the property
regex bool
name This property is required. String
Name of the property
values This property is required. List<String>
Values of the property
regex Boolean

GetManagementAgentsManagementAgent

AvailabilityStatus This property is required. string
Filter to return only Management Agents in the particular availability status.
CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
DataSourceLists This property is required. List<GetManagementAgentsManagementAgentDataSourceList>
DataSourceSummaryLists This property is required. List<GetManagementAgentsManagementAgentDataSourceSummaryList>
list of dataSources associated with the agent
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeployPluginsIds This property is required. List<string>
DisplayName This property is required. string
Filter to return only Management Agents having the particular display name.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Host This property is required. string
Management Agent host machine name
HostId This property is required. string
Filter to return only Management Agents having the particular agent host id.
Id This property is required. string
agent identifier
InstallKeyId This property is required. string
agent install key identifier
InstallPath This property is required. string
Path where Management Agent is installed
InstallType This property is required. string
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
IsAgentAutoUpgradable This property is required. bool
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
IsCustomerDeployed This property is required. bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ManagedAgentId This property is required. string
ManagementAgentProperties This property is required. List<GetManagementAgentsManagementAgentManagementAgentProperty>
Additional properties for this Management Agent
PlatformName This property is required. string
Platform Name
PlatformType This property is required. string
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
PlatformVersion This property is required. string
Platform Version
PluginLists This property is required. List<GetManagementAgentsManagementAgentPluginList>
list of managementAgentPlugins associated with the agent
ResourceArtifactVersion This property is required. string
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
State This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
TimeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
TimeLastHeartbeat This property is required. string
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
Version This property is required. string
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
AvailabilityStatus This property is required. string
Filter to return only Management Agents in the particular availability status.
CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
DataSourceLists This property is required. []GetManagementAgentsManagementAgentDataSourceList
DataSourceSummaryLists This property is required. []GetManagementAgentsManagementAgentDataSourceSummaryList
list of dataSources associated with the agent
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeployPluginsIds This property is required. []string
DisplayName This property is required. string
Filter to return only Management Agents having the particular display name.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Host This property is required. string
Management Agent host machine name
HostId This property is required. string
Filter to return only Management Agents having the particular agent host id.
Id This property is required. string
agent identifier
InstallKeyId This property is required. string
agent install key identifier
InstallPath This property is required. string
Path where Management Agent is installed
InstallType This property is required. string
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
IsAgentAutoUpgradable This property is required. bool
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
IsCustomerDeployed This property is required. bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
LifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
ManagedAgentId This property is required. string
ManagementAgentProperties This property is required. []GetManagementAgentsManagementAgentManagementAgentProperty
Additional properties for this Management Agent
PlatformName This property is required. string
Platform Name
PlatformType This property is required. string
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
PlatformVersion This property is required. string
Platform Version
PluginLists This property is required. []GetManagementAgentsManagementAgentPluginList
list of managementAgentPlugins associated with the agent
ResourceArtifactVersion This property is required. string
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
State This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
TimeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
TimeLastHeartbeat This property is required. string
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
Version This property is required. string
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
availabilityStatus This property is required. String
Filter to return only Management Agents in the particular availability status.
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
dataSourceLists This property is required. List<GetsDataSourceList>
dataSourceSummaryLists This property is required. List<GetsDataSourceSummaryList>
list of dataSources associated with the agent
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployPluginsIds This property is required. List<String>
displayName This property is required. String
Filter to return only Management Agents having the particular display name.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host This property is required. String
Management Agent host machine name
hostId This property is required. String
Filter to return only Management Agents having the particular agent host id.
id This property is required. String
agent identifier
installKeyId This property is required. String
agent install key identifier
installPath This property is required. String
Path where Management Agent is installed
installType This property is required. String
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
isAgentAutoUpgradable This property is required. Boolean
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
isCustomerDeployed This property is required. Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managedAgentId This property is required. String
managementAgentProperties This property is required. List<GetsProperty>
Additional properties for this Management Agent
platformName This property is required. String
Platform Name
platformType This property is required. String
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
platformVersion This property is required. String
Platform Version
pluginLists This property is required. List<GetsPluginList>
list of managementAgentPlugins associated with the agent
resourceArtifactVersion This property is required. String
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
state This property is required. String
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. String
The time the Management Agent was created. An RFC3339 formatted datetime string
timeLastHeartbeat This property is required. String
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Management Agent was last updated. An RFC3339 formatted datetime string
version This property is required. String
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
availabilityStatus This property is required. string
Filter to return only Management Agents in the particular availability status.
compartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
dataSourceLists This property is required. GetManagementAgentsManagementAgentDataSourceList[]
dataSourceSummaryLists This property is required. GetManagementAgentsManagementAgentDataSourceSummaryList[]
list of dataSources associated with the agent
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployPluginsIds This property is required. string[]
displayName This property is required. string
Filter to return only Management Agents having the particular display name.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host This property is required. string
Management Agent host machine name
hostId This property is required. string
Filter to return only Management Agents having the particular agent host id.
id This property is required. string
agent identifier
installKeyId This property is required. string
agent install key identifier
installPath This property is required. string
Path where Management Agent is installed
installType This property is required. string
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
isAgentAutoUpgradable This property is required. boolean
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
isCustomerDeployed This property is required. boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
lifecycleDetails This property is required. string
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managedAgentId This property is required. string
managementAgentProperties This property is required. GetManagementAgentsManagementAgentManagementAgentProperty[]
Additional properties for this Management Agent
platformName This property is required. string
Platform Name
platformType This property is required. string
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
platformVersion This property is required. string
Platform Version
pluginLists This property is required. GetManagementAgentsManagementAgentPluginList[]
list of managementAgentPlugins associated with the agent
resourceArtifactVersion This property is required. string
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
state This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
timeLastHeartbeat This property is required. string
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
timeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
version This property is required. string
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
availability_status This property is required. str
Filter to return only Management Agents in the particular availability status.
compartment_id This property is required. str
The OCID of the compartment to which a request will be scoped.
data_source_lists This property is required. Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceList]
data_source_summary_lists This property is required. Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceSummaryList]
list of dataSources associated with the agent
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploy_plugins_ids This property is required. Sequence[str]
display_name This property is required. str
Filter to return only Management Agents having the particular display name.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host This property is required. str
Management Agent host machine name
host_id This property is required. str
Filter to return only Management Agents having the particular agent host id.
id This property is required. str
agent identifier
install_key_id This property is required. str
agent install key identifier
install_path This property is required. str
Path where Management Agent is installed
install_type This property is required. str
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
is_agent_auto_upgradable This property is required. bool
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
is_customer_deployed This property is required. bool
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
lifecycle_details This property is required. str
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managed_agent_id This property is required. str
management_agent_properties This property is required. Sequence[managementagent.GetManagementAgentsManagementAgentManagementAgentProperty]
Additional properties for this Management Agent
platform_name This property is required. str
Platform Name
platform_type This property is required. str
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
platform_version This property is required. str
Platform Version
plugin_lists This property is required. Sequence[managementagent.GetManagementAgentsManagementAgentPluginList]
list of managementAgentPlugins associated with the agent
resource_artifact_version This property is required. str
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
state This property is required. str
Filter to return only Management Agents in the particular lifecycle state.
time_created This property is required. str
The time the Management Agent was created. An RFC3339 formatted datetime string
time_last_heartbeat This property is required. str
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
time_updated This property is required. str
The time the Management Agent was last updated. An RFC3339 formatted datetime string
version This property is required. str
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]
availabilityStatus This property is required. String
Filter to return only Management Agents in the particular availability status.
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
dataSourceLists This property is required. List<Property Map>
dataSourceSummaryLists This property is required. List<Property Map>
list of dataSources associated with the agent
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployPluginsIds This property is required. List<String>
displayName This property is required. String
Filter to return only Management Agents having the particular display name.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
host This property is required. String
Management Agent host machine name
hostId This property is required. String
Filter to return only Management Agents having the particular agent host id.
id This property is required. String
agent identifier
installKeyId This property is required. String
agent install key identifier
installPath This property is required. String
Path where Management Agent is installed
installType This property is required. String
A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
isAgentAutoUpgradable This property is required. Boolean
true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
isCustomerDeployed This property is required. Boolean
true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
lifecycleDetails This property is required. String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
managedAgentId This property is required. String
managementAgentProperties This property is required. List<Property Map>
Additional properties for this Management Agent
platformName This property is required. String
Platform Name
platformType This property is required. String
Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]
platformVersion This property is required. String
Platform Version
pluginLists This property is required. List<Property Map>
list of managementAgentPlugins associated with the agent
resourceArtifactVersion This property is required. String
Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
state This property is required. String
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. String
The time the Management Agent was created. An RFC3339 formatted datetime string
timeLastHeartbeat This property is required. String
The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Management Agent was last updated. An RFC3339 formatted datetime string
version This property is required. String
Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

GetManagementAgentsManagementAgentDataSourceList

AllowMetrics This property is required. string
CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
ConnectionTimeout This property is required. int
IsDaemonSet This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
Key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
MetricDimensions This property is required. List<GetManagementAgentsManagementAgentDataSourceListMetricDimension>
Name This property is required. string
Name of the property
Namespace This property is required. string
ProxyUrl This property is required. string
ReadDataLimit This property is required. int
ReadTimeout This property is required. int
ResourceGroup This property is required. string
ScheduleMins This property is required. int
State This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
TimeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
Type This property is required. string
The type of the DataSource.
Url This property is required. string
AllowMetrics This property is required. string
CompartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
ConnectionTimeout This property is required. int
IsDaemonSet This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
Key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
MetricDimensions This property is required. []GetManagementAgentsManagementAgentDataSourceListMetricDimension
Name This property is required. string
Name of the property
Namespace This property is required. string
ProxyUrl This property is required. string
ReadDataLimit This property is required. int
ReadTimeout This property is required. int
ResourceGroup This property is required. string
ScheduleMins This property is required. int
State This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
TimeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
TimeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
Type This property is required. string
The type of the DataSource.
Url This property is required. string
allowMetrics This property is required. String
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
connectionTimeout This property is required. Integer
isDaemonSet This property is required. Boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. String
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
metricDimensions This property is required. List<GetsDataSourceListMetricDimension>
name This property is required. String
Name of the property
namespace This property is required. String
proxyUrl This property is required. String
readDataLimit This property is required. Integer
readTimeout This property is required. Integer
resourceGroup This property is required. String
scheduleMins This property is required. Integer
state This property is required. String
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. String
The time the Management Agent was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Management Agent was last updated. An RFC3339 formatted datetime string
type This property is required. String
The type of the DataSource.
url This property is required. String
allowMetrics This property is required. string
compartmentId This property is required. string
The OCID of the compartment to which a request will be scoped.
connectionTimeout This property is required. number
isDaemonSet This property is required. boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
metricDimensions This property is required. GetManagementAgentsManagementAgentDataSourceListMetricDimension[]
name This property is required. string
Name of the property
namespace This property is required. string
proxyUrl This property is required. string
readDataLimit This property is required. number
readTimeout This property is required. number
resourceGroup This property is required. string
scheduleMins This property is required. number
state This property is required. string
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. string
The time the Management Agent was created. An RFC3339 formatted datetime string
timeUpdated This property is required. string
The time the Management Agent was last updated. An RFC3339 formatted datetime string
type This property is required. string
The type of the DataSource.
url This property is required. string
allow_metrics This property is required. str
compartment_id This property is required. str
The OCID of the compartment to which a request will be scoped.
connection_timeout This property is required. int
is_daemon_set This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. str
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
metric_dimensions This property is required. Sequence[managementagent.GetManagementAgentsManagementAgentDataSourceListMetricDimension]
name This property is required. str
Name of the property
namespace This property is required. str
proxy_url This property is required. str
read_data_limit This property is required. int
read_timeout This property is required. int
resource_group This property is required. str
schedule_mins This property is required. int
state This property is required. str
Filter to return only Management Agents in the particular lifecycle state.
time_created This property is required. str
The time the Management Agent was created. An RFC3339 formatted datetime string
time_updated This property is required. str
The time the Management Agent was last updated. An RFC3339 formatted datetime string
type This property is required. str
The type of the DataSource.
url This property is required. str
allowMetrics This property is required. String
compartmentId This property is required. String
The OCID of the compartment to which a request will be scoped.
connectionTimeout This property is required. Number
isDaemonSet This property is required. Boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. String
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
metricDimensions This property is required. List<Property Map>
name This property is required. String
Name of the property
namespace This property is required. String
proxyUrl This property is required. String
readDataLimit This property is required. Number
readTimeout This property is required. Number
resourceGroup This property is required. String
scheduleMins This property is required. Number
state This property is required. String
Filter to return only Management Agents in the particular lifecycle state.
timeCreated This property is required. String
The time the Management Agent was created. An RFC3339 formatted datetime string
timeUpdated This property is required. String
The time the Management Agent was last updated. An RFC3339 formatted datetime string
type This property is required. String
The type of the DataSource.
url This property is required. String

GetManagementAgentsManagementAgentDataSourceListMetricDimension

Name This property is required. string
Name of the property
Value This property is required. string
Name This property is required. string
Name of the property
Value This property is required. string
name This property is required. String
Name of the property
value This property is required. String
name This property is required. string
Name of the property
value This property is required. string
name This property is required. str
Name of the property
value This property is required. str
name This property is required. String
Name of the property
value This property is required. String

GetManagementAgentsManagementAgentDataSourceSummaryList

IsDaemonSet This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
Key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
Name This property is required. string
Name of the property
Type This property is required. string
The type of the DataSource.
IsDaemonSet This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
Key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
Name This property is required. string
Name of the property
Type This property is required. string
The type of the DataSource.
isDaemonSet This property is required. Boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. String
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
name This property is required. String
Name of the property
type This property is required. String
The type of the DataSource.
isDaemonSet This property is required. boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. string
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
name This property is required. string
Name of the property
type This property is required. string
The type of the DataSource.
is_daemon_set This property is required. bool
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. str
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
name This property is required. str
Name of the property
type This property is required. str
The type of the DataSource.
isDaemonSet This property is required. Boolean
If the Kubernetes cluster type is Daemon set then this will be set to true.
key This property is required. String
Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
name This property is required. String
Name of the property
type This property is required. String
The type of the DataSource.

GetManagementAgentsManagementAgentManagementAgentProperty

Name This property is required. string
Name of the property
Units This property is required. string
Unit for the property
Values This property is required. List<string>
Values of the property
Name This property is required. string
Name of the property
Units This property is required. string
Unit for the property
Values This property is required. []string
Values of the property
name This property is required. String
Name of the property
units This property is required. String
Unit for the property
values This property is required. List<String>
Values of the property
name This property is required. string
Name of the property
units This property is required. string
Unit for the property
values This property is required. string[]
Values of the property
name This property is required. str
Name of the property
units This property is required. str
Unit for the property
values This property is required. Sequence[str]
Values of the property
name This property is required. String
Name of the property
units This property is required. String
Unit for the property
values This property is required. List<String>
Values of the property

GetManagementAgentsManagementAgentPluginList

IsEnabled This property is required. bool
flag indicating whether the plugin is in enabled mode or disabled mode.
PluginDisplayName This property is required. string
Management Agent Plugin Identifier, can be renamed
PluginId This property is required. string
Plugin Id
PluginName This property is required. string
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
PluginStatus This property is required. string
Plugin Status
PluginStatusMessage This property is required. string
Status message of the Plugin
PluginVersion This property is required. string
Plugin Version
IsEnabled This property is required. bool
flag indicating whether the plugin is in enabled mode or disabled mode.
PluginDisplayName This property is required. string
Management Agent Plugin Identifier, can be renamed
PluginId This property is required. string
Plugin Id
PluginName This property is required. string
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
PluginStatus This property is required. string
Plugin Status
PluginStatusMessage This property is required. string
Status message of the Plugin
PluginVersion This property is required. string
Plugin Version
isEnabled This property is required. Boolean
flag indicating whether the plugin is in enabled mode or disabled mode.
pluginDisplayName This property is required. String
Management Agent Plugin Identifier, can be renamed
pluginId This property is required. String
Plugin Id
pluginName This property is required. String
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
pluginStatus This property is required. String
Plugin Status
pluginStatusMessage This property is required. String
Status message of the Plugin
pluginVersion This property is required. String
Plugin Version
isEnabled This property is required. boolean
flag indicating whether the plugin is in enabled mode or disabled mode.
pluginDisplayName This property is required. string
Management Agent Plugin Identifier, can be renamed
pluginId This property is required. string
Plugin Id
pluginName This property is required. string
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
pluginStatus This property is required. string
Plugin Status
pluginStatusMessage This property is required. string
Status message of the Plugin
pluginVersion This property is required. string
Plugin Version
is_enabled This property is required. bool
flag indicating whether the plugin is in enabled mode or disabled mode.
plugin_display_name This property is required. str
Management Agent Plugin Identifier, can be renamed
plugin_id This property is required. str
Plugin Id
plugin_name This property is required. str
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
plugin_status This property is required. str
Plugin Status
plugin_status_message This property is required. str
Status message of the Plugin
plugin_version This property is required. str
Plugin Version
isEnabled This property is required. Boolean
flag indicating whether the plugin is in enabled mode or disabled mode.
pluginDisplayName This property is required. String
Management Agent Plugin Identifier, can be renamed
pluginId This property is required. String
Plugin Id
pluginName This property is required. String
Array of pluginName to return only Management Agents having the particular Plugins installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed. Example: ["PluginA"]
pluginStatus This property is required. String
Plugin Status
pluginStatusMessage This property is required. String
Status message of the Plugin
pluginVersion This property is required. String
Plugin Version

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi