Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getManagementAgent

This data source provides details about a specific Management Agent resource in Oracle Cloud Infrastructure Management Agent service.

Gets complete details of the inventory of a given agent id

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testManagementAgent = Oci.ManagementAgent.GetManagementAgent.Invoke(new()
    {
        ManagementAgentId = oci_management_agent_management_agent.Test_management_agent.Id,
    });

});
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.GetManagementAgent(ctx, &managementagent.GetManagementAgentArgs{
			ManagementAgentId: oci_management_agent_management_agent.Test_management_agent.Id,
		}, 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.GetManagementAgentArgs;
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 testManagementAgent = ManagementAgentFunctions.getManagementAgent(GetManagementAgentArgs.builder()
            .managementAgentId(oci_management_agent_management_agent.test_management_agent().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_management_agent = oci.ManagementAgent.get_management_agent(management_agent_id=oci_management_agent_management_agent["test_management_agent"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testManagementAgent = oci.ManagementAgent.getManagementAgent({
    managementAgentId: oci_management_agent_management_agent.test_management_agent.id,
});
variables:
  testManagementAgent:
    Fn::Invoke:
      Function: oci:ManagementAgent:getManagementAgent
      Arguments:
        managementAgentId: ${oci_management_agent_management_agent.test_management_agent.id}

Using getManagementAgent

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 getManagementAgent(args: GetManagementAgentArgs, opts?: InvokeOptions): Promise<GetManagementAgentResult>
function getManagementAgentOutput(args: GetManagementAgentOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentResult>
def get_management_agent(management_agent_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagementAgentResult
def get_management_agent_output(management_agent_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentResult]
func GetManagementAgent(ctx *Context, args *GetManagementAgentArgs, opts ...InvokeOption) (*GetManagementAgentResult, error)
func GetManagementAgentOutput(ctx *Context, args *GetManagementAgentOutputArgs, opts ...InvokeOption) GetManagementAgentResultOutput

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

public static class GetManagementAgent 
{
    public static Task<GetManagementAgentResult> InvokeAsync(GetManagementAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentResult> Invoke(GetManagementAgentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetManagementAgentResult> getManagementAgent(GetManagementAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:ManagementAgent/getManagementAgent:getManagementAgent
  arguments:
    # arguments dictionary

The following arguments are supported:

ManagementAgentId string

Unique Management Agent identifier

ManagementAgentId string

Unique Management Agent identifier

managementAgentId String

Unique Management Agent identifier

managementAgentId string

Unique Management Agent identifier

management_agent_id str

Unique Management Agent identifier

managementAgentId String

Unique Management Agent identifier

getManagementAgent Result

The following output properties are available:

AvailabilityStatus string

The current availability status of managementAgent

CompartmentId string

Compartment Identifier

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

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

Host resource ocid

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

InstallType string

The install type, either AGENT or GATEWAY

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

Platform Name

PlatformType string

Platform Type

PlatformVersion string

Platform Version

PluginLists List<GetManagementAgentPluginList>

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

The current state of managementAgent

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

Management Agent Version

AvailabilityStatus string

The current availability status of managementAgent

CompartmentId string

Compartment Identifier

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

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

Host resource ocid

Id string

agent identifier

InstallKeyId string

agent install key identifier

InstallPath string

Path where Management Agent is installed

InstallType string

The install type, either AGENT or GATEWAY

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

Platform Name

PlatformType string

Platform Type

PlatformVersion string

Platform Version

PluginLists []GetManagementAgentPluginList

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

The current state of managementAgent

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

Management Agent Version

availabilityStatus String

The current availability status of managementAgent

compartmentId String

Compartment Identifier

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

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

Host resource ocid

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

installType String

The install type, either AGENT or GATEWAY

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

Platform Name

platformType String

Platform Type

platformVersion String

Platform Version

pluginLists List<GetPluginList>

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

The current state of managementAgent

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

Management Agent Version

availabilityStatus string

The current availability status of managementAgent

compartmentId string

Compartment Identifier

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

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

Host resource ocid

id string

agent identifier

installKeyId string

agent install key identifier

installPath string

Path where Management Agent is installed

installType string

The install type, either AGENT or GATEWAY

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

Platform Name

platformType string

Platform Type

platformVersion string

Platform Version

pluginLists GetManagementAgentPluginList[]

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

The current state of managementAgent

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

Management Agent Version

availability_status str

The current availability status of managementAgent

compartment_id str

Compartment Identifier

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

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

Host resource ocid

id str

agent identifier

install_key_id str

agent install key identifier

install_path str

Path where Management Agent is installed

install_type str

The install type, either AGENT or GATEWAY

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

Platform Name

platform_type str

Platform Type

platform_version str

Platform Version

plugin_lists GetManagementAgentPluginList]

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

The current state of managementAgent

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

Management Agent Version

availabilityStatus String

The current availability status of managementAgent

compartmentId String

Compartment Identifier

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

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

Host resource ocid

id String

agent identifier

installKeyId String

agent install key identifier

installPath String

Path where Management Agent is installed

installType String

The install type, either AGENT or GATEWAY

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

Platform Name

platformType String

Platform Type

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

The current state of managementAgent

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

Management Agent Version

Supporting Types

GetManagementAgentPluginList

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

Management Agent Plugin Name

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

Management Agent Plugin Name

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

Management Agent Plugin Name

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

Management Agent Plugin Name

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

Management Agent Plugin Name

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

Management Agent Plugin Name

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.