Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Opsi
  5. HostInsight
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Opsi.HostInsight

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Host Insight resource in Oracle Cloud Infrastructure Opsi service.

    Create a Host Insight resource for a host in Ops Insights. The host will be enabled in Ops Insights. Host metric collection and analysis will be started.

    Create HostInsight Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new HostInsight(name: string, args: HostInsightArgs, opts?: CustomResourceOptions);
    @overload
def HostInsight(resource_name: str,
                args: HostInsightArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def HostInsight(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                entity_source: Optional[str] = None,
                compute_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                enterprise_manager_bridge_id: Optional[str] = None,
                enterprise_manager_entity_identifier: Optional[str] = None,
                enterprise_manager_identifier: Optional[str] = None,
                exadata_insight_id: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                management_agent_id: Optional[str] = None,
                status: Optional[str] = None)
    func NewHostInsight(ctx *Context, name string, args HostInsightArgs, opts ...ResourceOption) (*HostInsight, error)
    public HostInsight(string name, HostInsightArgs args, CustomResourceOptions? opts = null)
    public HostInsight(String name, HostInsightArgs args)
public HostInsight(String name, HostInsightArgs args, CustomResourceOptions options)

    type: oci:Opsi:HostInsight
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args HostInsightArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args HostInsightArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args HostInsightArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostInsightArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostInsightArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hostInsightResource = new Oci.Opsi.HostInsight("hostInsightResource", new()
{
    CompartmentId = "string",
    EntitySource = "string",
    ComputeId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    EnterpriseManagerBridgeId = "string",
    EnterpriseManagerEntityIdentifier = "string",
    EnterpriseManagerIdentifier = "string",
    ExadataInsightId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    ManagementAgentId = "string",
    Status = "string",
});

    example, err := Opsi.NewHostInsight(ctx, "hostInsightResource", &Opsi.HostInsightArgs{
	CompartmentId: pulumi.String("string"),
	EntitySource:  pulumi.String("string"),
	ComputeId:     pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EnterpriseManagerBridgeId:         pulumi.String("string"),
	EnterpriseManagerEntityIdentifier: pulumi.String("string"),
	EnterpriseManagerIdentifier:       pulumi.String("string"),
	ExadataInsightId:                  pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ManagementAgentId: pulumi.String("string"),
	Status:            pulumi.String("string"),
})

    var hostInsightResource = new HostInsight("hostInsightResource", HostInsightArgs.builder()
    .compartmentId("string")
    .entitySource("string")
    .computeId("string")
    .definedTags(Map.of("string", "string"))
    .enterpriseManagerBridgeId("string")
    .enterpriseManagerEntityIdentifier("string")
    .enterpriseManagerIdentifier("string")
    .exadataInsightId("string")
    .freeformTags(Map.of("string", "string"))
    .managementAgentId("string")
    .status("string")
    .build());

    host_insight_resource = oci.opsi.HostInsight("hostInsightResource",
    compartment_id="string",
    entity_source="string",
    compute_id="string",
    defined_tags={
        "string": "string",
    },
    enterprise_manager_bridge_id="string",
    enterprise_manager_entity_identifier="string",
    enterprise_manager_identifier="string",
    exadata_insight_id="string",
    freeform_tags={
        "string": "string",
    },
    management_agent_id="string",
    status="string")

    const hostInsightResource = new oci.opsi.HostInsight("hostInsightResource", {
    compartmentId: "string",
    entitySource: "string",
    computeId: "string",
    definedTags: {
        string: "string",
    },
    enterpriseManagerBridgeId: "string",
    enterpriseManagerEntityIdentifier: "string",
    enterpriseManagerIdentifier: "string",
    exadataInsightId: "string",
    freeformTags: {
        string: "string",
    },
    managementAgentId: "string",
    status: "string",
});

    type: oci:Opsi:HostInsight
properties:
    compartmentId: string
    computeId: string
    definedTags:
        string: string
    enterpriseManagerBridgeId: string
    enterpriseManagerEntityIdentifier: string
    enterpriseManagerIdentifier: string
    entitySource: string
    exadataInsightId: string
    freeformTags:
        string: string
    managementAgentId: string
    status: string

    HostInsight Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The HostInsight resource accepts the following input properties:

    CompartmentId string
    (Updatable) Compartment Identifier of host
    EntitySource string
    (Updatable) Source of the host entity.
    ComputeId string
    The OCID of the Compute Instance
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    EnterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    EnterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    EnterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    ExadataInsightId string
    The OCID of the Exadata insight.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ManagementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    Status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    CompartmentId string
    (Updatable) Compartment Identifier of host
    EntitySource string
    (Updatable) Source of the host entity.
    ComputeId string
    The OCID of the Compute Instance
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    EnterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    EnterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    EnterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    ExadataInsightId string
    The OCID of the Exadata insight.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ManagementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    Status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    compartmentId String
    (Updatable) Compartment Identifier of host
    entitySource String
    (Updatable) Source of the host entity.
    computeId String
    The OCID of the Compute Instance
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId String
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityIdentifier String
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerIdentifier String
    Enterprise Manager Unique Identifier
    exadataInsightId String
    The OCID of the Exadata insight.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    managementAgentId String

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    status String
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    compartmentId string
    (Updatable) Compartment Identifier of host
    entitySource string
    (Updatable) Source of the host entity.
    computeId string
    The OCID of the Compute Instance
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    exadataInsightId string
    The OCID of the Exadata insight.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    managementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    compartment_id str
    (Updatable) Compartment Identifier of host
    entity_source str
    (Updatable) Source of the host entity.
    compute_id str
    The OCID of the Compute Instance
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterprise_manager_bridge_id str
    OPSI Enterprise Manager Bridge OCID
    enterprise_manager_entity_identifier str
    Enterprise Manager Entity Unique Identifier
    enterprise_manager_identifier str
    Enterprise Manager Unique Identifier
    exadata_insight_id str
    The OCID of the Exadata insight.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    management_agent_id str

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    status str
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    compartmentId String
    (Updatable) Compartment Identifier of host
    entitySource String
    (Updatable) Source of the host entity.
    computeId String
    The OCID of the Compute Instance
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId String
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityIdentifier String
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerIdentifier String
    Enterprise Manager Unique Identifier
    exadataInsightId String
    The OCID of the Exadata insight.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    managementAgentId String

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    status String
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"

    Outputs

    All input properties are implicitly available as output properties. Additionally, the HostInsight resource produces the following output properties:

    EnterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    EnterpriseManagerEntityName string
    Enterprise Manager Entity Name
    EnterpriseManagerEntityType string
    Enterprise Manager Entity Type
    HostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    HostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    HostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    PlatformName string
    Platform name.
    PlatformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    PlatformVersion string
    Platform version.
    ProcessorCount int
    State string
    The current state of the host.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    EnterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    EnterpriseManagerEntityName string
    Enterprise Manager Entity Name
    EnterpriseManagerEntityType string
    Enterprise Manager Entity Type
    HostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    HostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    HostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    PlatformName string
    Platform name.
    PlatformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    PlatformVersion string
    Platform version.
    ProcessorCount int
    State string
    The current state of the host.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    enterpriseManagerEntityDisplayName String
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityName String
    Enterprise Manager Entity Name
    enterpriseManagerEntityType String
    Enterprise Manager Entity Type
    hostDisplayName String
    The user-friendly name for the host. The name does not have to be unique.
    hostName String
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType String
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    platformName String
    Platform name.
    platformType String
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion String
    Platform version.
    processorCount Integer
    state String
    The current state of the host.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated String
    The time the host insight was updated. An RFC3339 formatted datetime string
    enterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityName string
    Enterprise Manager Entity Name
    enterpriseManagerEntityType string
    Enterprise Manager Entity Type
    hostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    hostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    platformName string
    Platform name.
    platformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion string
    Platform version.
    processorCount number
    state string
    The current state of the host.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    enterprise_manager_entity_display_name str
    Enterprise Manager Entity Display Name
    enterprise_manager_entity_name str
    Enterprise Manager Entity Name
    enterprise_manager_entity_type str
    Enterprise Manager Entity Type
    host_display_name str
    The user-friendly name for the host. The name does not have to be unique.
    host_name str
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    host_type str
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    platform_name str
    Platform name.
    platform_type str
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platform_version str
    Platform version.
    processor_count int
    state str
    The current state of the host.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    time_updated str
    The time the host insight was updated. An RFC3339 formatted datetime string
    enterpriseManagerEntityDisplayName String
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityName String
    Enterprise Manager Entity Name
    enterpriseManagerEntityType String
    Enterprise Manager Entity Type
    hostDisplayName String
    The user-friendly name for the host. The name does not have to be unique.
    hostName String
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType String
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    platformName String
    Platform name.
    platformType String
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion String
    Platform version.
    processorCount Number
    state String
    The current state of the host.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated String
    The time the host insight was updated. An RFC3339 formatted datetime string

    Look up Existing HostInsight Resource

    Get an existing HostInsight resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: HostInsightState, opts?: CustomResourceOptions): HostInsight
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        compute_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        enterprise_manager_bridge_id: Optional[str] = None,
        enterprise_manager_entity_display_name: Optional[str] = None,
        enterprise_manager_entity_identifier: Optional[str] = None,
        enterprise_manager_entity_name: Optional[str] = None,
        enterprise_manager_entity_type: Optional[str] = None,
        enterprise_manager_identifier: Optional[str] = None,
        entity_source: Optional[str] = None,
        exadata_insight_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        host_display_name: Optional[str] = None,
        host_name: Optional[str] = None,
        host_type: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        management_agent_id: Optional[str] = None,
        platform_name: Optional[str] = None,
        platform_type: Optional[str] = None,
        platform_version: Optional[str] = None,
        processor_count: Optional[int] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> HostInsight
    func GetHostInsight(ctx *Context, name string, id IDInput, state *HostInsightState, opts ...ResourceOption) (*HostInsight, error)
    public static HostInsight Get(string name, Input<string> id, HostInsightState? state, CustomResourceOptions? opts = null)
    public static HostInsight get(String name, Output<String> id, HostInsightState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) Compartment Identifier of host
    ComputeId string
    The OCID of the Compute Instance
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    EnterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    EnterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    EnterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    EnterpriseManagerEntityName string
    Enterprise Manager Entity Name
    EnterpriseManagerEntityType string
    Enterprise Manager Entity Type
    EnterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    EntitySource string
    (Updatable) Source of the host entity.
    ExadataInsightId string
    The OCID of the Exadata insight.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    HostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    HostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    ManagementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    PlatformName string
    Platform name.
    PlatformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    PlatformVersion string
    Platform version.
    ProcessorCount int
    State string
    The current state of the host.
    Status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    CompartmentId string
    (Updatable) Compartment Identifier of host
    ComputeId string
    The OCID of the Compute Instance
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    EnterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    EnterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    EnterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    EnterpriseManagerEntityName string
    Enterprise Manager Entity Name
    EnterpriseManagerEntityType string
    Enterprise Manager Entity Type
    EnterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    EntitySource string
    (Updatable) Source of the host entity.
    ExadataInsightId string
    The OCID of the Exadata insight.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    HostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    HostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    HostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    ManagementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    PlatformName string
    Platform name.
    PlatformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    PlatformVersion string
    Platform version.
    ProcessorCount int
    State string
    The current state of the host.
    Status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    compartmentId String
    (Updatable) Compartment Identifier of host
    computeId String
    The OCID of the Compute Instance
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId String
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityDisplayName String
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityIdentifier String
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerEntityName String
    Enterprise Manager Entity Name
    enterpriseManagerEntityType String
    Enterprise Manager Entity Type
    enterpriseManagerIdentifier String
    Enterprise Manager Unique Identifier
    entitySource String
    (Updatable) Source of the host entity.
    exadataInsightId String
    The OCID of the Exadata insight.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostDisplayName String
    The user-friendly name for the host. The name does not have to be unique.
    hostName String
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType String
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    managementAgentId String

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    platformName String
    Platform name.
    platformType String
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion String
    Platform version.
    processorCount Integer
    state String
    The current state of the host.
    status String
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated String
    The time the host insight was updated. An RFC3339 formatted datetime string
    compartmentId string
    (Updatable) Compartment Identifier of host
    computeId string
    The OCID of the Compute Instance
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId string
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityDisplayName string
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityIdentifier string
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerEntityName string
    Enterprise Manager Entity Name
    enterpriseManagerEntityType string
    Enterprise Manager Entity Type
    enterpriseManagerIdentifier string
    Enterprise Manager Unique Identifier
    entitySource string
    (Updatable) Source of the host entity.
    exadataInsightId string
    The OCID of the Exadata insight.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostDisplayName string
    The user-friendly name for the host. The name does not have to be unique.
    hostName string
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType string
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    managementAgentId string

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    platformName string
    Platform name.
    platformType string
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion string
    Platform version.
    processorCount number
    state string
    The current state of the host.
    status string
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated string
    The time the host insight was updated. An RFC3339 formatted datetime string
    compartment_id str
    (Updatable) Compartment Identifier of host
    compute_id str
    The OCID of the Compute Instance
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterprise_manager_bridge_id str
    OPSI Enterprise Manager Bridge OCID
    enterprise_manager_entity_display_name str
    Enterprise Manager Entity Display Name
    enterprise_manager_entity_identifier str
    Enterprise Manager Entity Unique Identifier
    enterprise_manager_entity_name str
    Enterprise Manager Entity Name
    enterprise_manager_entity_type str
    Enterprise Manager Entity Type
    enterprise_manager_identifier str
    Enterprise Manager Unique Identifier
    entity_source str
    (Updatable) Source of the host entity.
    exadata_insight_id str
    The OCID of the Exadata insight.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    host_display_name str
    The user-friendly name for the host. The name does not have to be unique.
    host_name str
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    host_type str
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    management_agent_id str

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    platform_name str
    Platform name.
    platform_type str
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platform_version str
    Platform version.
    processor_count int
    state str
    The current state of the host.
    status str
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    time_updated str
    The time the host insight was updated. An RFC3339 formatted datetime string
    compartmentId String
    (Updatable) Compartment Identifier of host
    computeId String
    The OCID of the Compute Instance
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    enterpriseManagerBridgeId String
    OPSI Enterprise Manager Bridge OCID
    enterpriseManagerEntityDisplayName String
    Enterprise Manager Entity Display Name
    enterpriseManagerEntityIdentifier String
    Enterprise Manager Entity Unique Identifier
    enterpriseManagerEntityName String
    Enterprise Manager Entity Name
    enterpriseManagerEntityType String
    Enterprise Manager Entity Type
    enterpriseManagerIdentifier String
    Enterprise Manager Unique Identifier
    entitySource String
    (Updatable) Source of the host entity.
    exadataInsightId String
    The OCID of the Exadata insight.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    hostDisplayName String
    The user-friendly name for the host. The name does not have to be unique.
    hostName String
    The host name. The host name is unique amongst the hosts managed by the same management agent.
    hostType String
    Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST.
    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.
    managementAgentId String

    The OCID of the Management Agent

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values. The resource destruction here is basically a soft delete. User cannot create resource using the same Management agent OCID. If resource is in enabled state during destruction, the resource will be disabled automatically before performing delete operation.

    platformName String
    Platform name.
    platformType String
    Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX].
    platformVersion String
    Platform version.
    processorCount Number
    state String
    The current state of the host.
    status String
    (Updatable) Status of the resource. Example: "ENABLED", "DISABLED". Resource can be either enabled or disabled by updating the value of status field to either "ENABLED" or "DISABLED"
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the the host insight was first enabled. An RFC3339 formatted datetime string
    timeUpdated String
    The time the host insight was updated. An RFC3339 formatted datetime string

    Import

    HostInsights can be imported using the id, e.g.

    $ pulumi import oci:Opsi/hostInsight:HostInsight test_host_insight "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci