getManagementAgents

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testManagementAgents = Oci.ManagementAgent.GetManagementAgents.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        AccessLevel = @var.Management_agent_access_level,
        AvailabilityStatus = @var.Management_agent_availability_status,
        CompartmentIdInSubtree = @var.Management_agent_compartment_id_in_subtree,
        DisplayName = @var.Management_agent_display_name,
        HostId = oci_management_agent_host.Test_host.Id,
        InstallType = @var.Management_agent_install_type,
        IsCustomerDeployed = @var.Management_agent_is_customer_deployed,
        PlatformTypes = @var.Management_agent_platform_type,
        PluginNames = @var.Management_agent_plugin_name,
        State = @var.Management_agent_state,
        Versions = @var.Management_agent_version,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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:          _var.Compartment_id,
			AccessLevel:            pulumi.StringRef(_var.Management_agent_access_level),
			AvailabilityStatus:     pulumi.StringRef(_var.Management_agent_availability_status),
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Management_agent_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Management_agent_display_name),
			HostId:                 pulumi.StringRef(oci_management_agent_host.Test_host.Id),
			InstallType:            pulumi.StringRef(_var.Management_agent_install_type),
			IsCustomerDeployed:     pulumi.BoolRef(_var.Management_agent_is_customer_deployed),
			PlatformTypes:          _var.Management_agent_platform_type,
			PluginNames:            _var.Management_agent_plugin_name,
			State:                  pulumi.StringRef(_var.Management_agent_state),
			Versions:               _var.Management_agent_version,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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(var_.compartment_id())
            .accessLevel(var_.management_agent_access_level())
            .availabilityStatus(var_.management_agent_availability_status())
            .compartmentIdInSubtree(var_.management_agent_compartment_id_in_subtree())
            .displayName(var_.management_agent_display_name())
            .hostId(oci_management_agent_host.test_host().id())
            .installType(var_.management_agent_install_type())
            .isCustomerDeployed(var_.management_agent_is_customer_deployed())
            .platformTypes(var_.management_agent_platform_type())
            .pluginNames(var_.management_agent_plugin_name())
            .state(var_.management_agent_state())
            .versions(var_.management_agent_version())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_management_agents = oci.ManagementAgent.get_management_agents(compartment_id=var["compartment_id"],
    access_level=var["management_agent_access_level"],
    availability_status=var["management_agent_availability_status"],
    compartment_id_in_subtree=var["management_agent_compartment_id_in_subtree"],
    display_name=var["management_agent_display_name"],
    host_id=oci_management_agent_host["test_host"]["id"],
    install_type=var["management_agent_install_type"],
    is_customer_deployed=var["management_agent_is_customer_deployed"],
    platform_types=var["management_agent_platform_type"],
    plugin_names=var["management_agent_plugin_name"],
    state=var["management_agent_state"],
    versions=var["management_agent_version"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testManagementAgents = oci.ManagementAgent.getManagementAgents({
    compartmentId: _var.compartment_id,
    accessLevel: _var.management_agent_access_level,
    availabilityStatus: _var.management_agent_availability_status,
    compartmentIdInSubtree: _var.management_agent_compartment_id_in_subtree,
    displayName: _var.management_agent_display_name,
    hostId: oci_management_agent_host.test_host.id,
    installType: _var.management_agent_install_type,
    isCustomerDeployed: _var.management_agent_is_customer_deployed,
    platformTypes: _var.management_agent_platform_type,
    pluginNames: _var.management_agent_plugin_name,
    state: _var.management_agent_state,
    versions: _var.management_agent_version,
});
variables:
  testManagementAgents:
    Fn::Invoke:
      Function: oci:ManagementAgent:getManagementAgents
      Arguments:
        compartmentId: ${var.compartment_id}
        accessLevel: ${var.management_agent_access_level}
        availabilityStatus: ${var.management_agent_availability_status}
        compartmentIdInSubtree: ${var.management_agent_compartment_id_in_subtree}
        displayName: ${var.management_agent_display_name}
        hostId: ${oci_management_agent_host.test_host.id}
        installType: ${var.management_agent_install_type}
        isCustomerDeployed: ${var.management_agent_is_customer_deployed}
        platformTypes: ${var.management_agent_platform_type}
        pluginNames: ${var.management_agent_plugin_name}
        state: ${var.management_agent_state}
        versions: ${var.management_agent_version}

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>
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,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[_managementagent.GetManagementAgentsFilter]] = 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,
                          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,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_managementagent.GetManagementAgentsFilterArgs]]]] = 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,
                          opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentsResult]
func GetManagementAgents(ctx *Context, args *GetManagementAgentsArgs, opts ...InvokeOption) (*GetManagementAgentsResult, error)
func GetManagementAgentsOutput(ctx *Context, args *GetManagementAgentsOutputArgs, opts ...InvokeOption) GetManagementAgentsResultOutput

> 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)
}
public static CompletableFuture<GetManagementAgentsResult> getManagementAgents(GetManagementAgentsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:ManagementAgent/getManagementAgents:getManagementAgents
  arguments:
    # arguments dictionary

The following arguments are supported:

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

DisplayName string

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

Filters List<GetManagementAgentsFilter>
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"]

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

DisplayName string

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

Filters []GetManagementAgentsFilter
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"]

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

displayName String

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

filters List<GetsFilter>
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"]

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

displayName string

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

filters GetManagementAgentsFilter[]
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"]

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

display_name str

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

filters GetManagementAgentsFilter]
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"]

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

displayName String

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

filters List<Property Map>
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"]

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

Management Agent Name

Filters List<GetManagementAgentsFilter>
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

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

Management Agent Name

Filters []GetManagementAgentsFilter
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

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

Management Agent Name

filters List<GetsFilter>
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

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

Management Agent Name

filters GetManagementAgentsFilter[]
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

compartment_id str

Compartment Identifier

id str

The provider-assigned unique ID for this managed resource.

management_agents GetManagementAgentsManagementAgent]

The list of management_agents.

access_level str
availability_status str

The current availability status of managementAgent

compartment_id_in_subtree bool
display_name str

Management Agent Name

filters GetManagementAgentsFilter]
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

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

Management Agent Name

filters List<Property Map>
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

Supporting Types

GetManagementAgentsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetManagementAgentsManagementAgent

AvailabilityStatus string

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

CompartmentId string

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

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeployPluginsIds List<string>
DisplayName string

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

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

Management Agent host machine name

HostId string

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

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

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.

IsAgentAutoUpgradable 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 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 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 string
PlatformName string

Platform Name

PlatformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PlatformVersion string

Platform Version

PluginLists List<GetManagementAgentsManagementAgentPluginList>

list of managementAgentPlugins associated with the agent

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

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

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

AvailabilityStatus string

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

CompartmentId string

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

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DeployPluginsIds []string
DisplayName string

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

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Host string

Management Agent host machine name

HostId string

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

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

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.

IsAgentAutoUpgradable 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 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 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 string
PlatformName string

Platform Name

PlatformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

PlatformVersion string

Platform Version

PluginLists []GetManagementAgentsManagementAgentPluginList

list of managementAgentPlugins associated with the agent

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

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

TimeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

Version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus String

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

compartmentId String

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

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds List<String>
displayName String

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

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

Management Agent host machine name

hostId String

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

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

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.

isAgentAutoUpgradable 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 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 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 String
platformName String

Platform Name

platformType String

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion String

Platform Version

pluginLists List<GetsPluginList>

list of managementAgentPlugins associated with the agent

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

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

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version String

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus string

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

compartmentId string

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

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds string[]
displayName string

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

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host string

Management Agent host machine name

hostId string

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

id string

agent identifier

installKeyId string

agent install key identifier

installPath string

Path where Management Agent is installed

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.

isAgentAutoUpgradable 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 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 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 string
platformName string

Platform Name

platformType string

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion string

Platform Version

pluginLists GetManagementAgentsManagementAgentPluginList[]

list of managementAgentPlugins associated with the agent

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

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

timeCreated string

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version string

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availability_status str

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

compartment_id str

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

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deploy_plugins_ids Sequence[str]
display_name str

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

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host str

Management Agent host machine name

host_id str

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

id str

agent identifier

install_key_id str

agent install key identifier

install_path str

Path where Management Agent is installed

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_agent_auto_upgradable 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 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 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 str
platform_name str

Platform Name

platform_type str

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platform_version str

Platform Version

plugin_lists GetManagementAgentsManagementAgentPluginList]

list of managementAgentPlugins associated with the agent

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

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

time_created str

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version str

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

availabilityStatus String

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

compartmentId String

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

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

deployPluginsIds List<String>
displayName String

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

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

host String

Management Agent host machine name

hostId String

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

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

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.

isAgentAutoUpgradable 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 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 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 String
platformName String

Platform Name

platformType String

Array of PlatformTypes to return only results having the particular platform types. Example: ["LINUX"]

platformVersion String

Platform Version

pluginLists List<Property Map>

list of managementAgentPlugins associated with the agent

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

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

timeCreated String

The time the Management Agent was created. An RFC3339 formatted datetime string

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

The time the Management Agent was last updated. An RFC3339 formatted datetime string

version String

Array of versions to return only Management Agents having the particular agent versions. Example: ["202020.0101","210201.0513"]

GetManagementAgentsManagementAgentPluginList

IsEnabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

PluginDisplayName string

Management Agent Plugin Identifier, can be renamed

PluginId string

Plugin Id

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

Plugin Status

PluginStatusMessage string

Status message of the Plugin

PluginVersion string

Plugin Version

IsEnabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

PluginDisplayName string

Management Agent Plugin Identifier, can be renamed

PluginId string

Plugin Id

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

Plugin Status

PluginStatusMessage string

Status message of the Plugin

PluginVersion string

Plugin Version

isEnabled Boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName String

Management Agent Plugin Identifier, can be renamed

pluginId String

Plugin Id

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

Plugin Status

pluginStatusMessage String

Status message of the Plugin

pluginVersion String

Plugin Version

isEnabled boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName string

Management Agent Plugin Identifier, can be renamed

pluginId string

Plugin Id

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

Plugin Status

pluginStatusMessage string

Status message of the Plugin

pluginVersion string

Plugin Version

is_enabled bool

flag indicating whether the plugin is in enabled mode or disabled mode.

plugin_display_name str

Management Agent Plugin Identifier, can be renamed

plugin_id str

Plugin Id

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

Plugin Status

plugin_status_message str

Status message of the Plugin

plugin_version str

Plugin Version

isEnabled Boolean

flag indicating whether the plugin is in enabled mode or disabled mode.

pluginDisplayName String

Management Agent Plugin Identifier, can be renamed

pluginId String

Plugin Id

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

Plugin Status

pluginStatusMessage String

Status message of the Plugin

pluginVersion String

Plugin Version

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.