Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSchematicsAgent
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSchematicsAgent

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for schematics_agent. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

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

const schematicsAgent = ibm.getSchematicsAgent({
    agentId: "agent_id",
});

    import pulumi
import pulumi_ibm as ibm

schematics_agent = ibm.get_schematics_agent(agent_id="agent_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupSchematicsAgent(ctx, &ibm.LookupSchematicsAgentArgs{
			AgentId: "agent_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var schematicsAgent = Ibm.GetSchematicsAgent.Invoke(new()
    {
        AgentId = "agent_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSchematicsAgentArgs;
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 schematicsAgent = IbmFunctions.getSchematicsAgent(GetSchematicsAgentArgs.builder()
            .agentId("agent_id")
            .build());

    }
}

    variables:
  schematicsAgent:
    fn::invoke:
      function: ibm:getSchematicsAgent
      arguments:
        agentId: agent_id

    Using getSchematicsAgent

    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 getSchematicsAgent(args: GetSchematicsAgentArgs, opts?: InvokeOptions): Promise<GetSchematicsAgentResult>
function getSchematicsAgentOutput(args: GetSchematicsAgentOutputArgs, opts?: InvokeOptions): Output<GetSchematicsAgentResult>
    def get_schematics_agent(agent_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetSchematicsAgentResult
def get_schematics_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsAgentResult]
    func LookupSchematicsAgent(ctx *Context, args *LookupSchematicsAgentArgs, opts ...InvokeOption) (*LookupSchematicsAgentResult, error)
func LookupSchematicsAgentOutput(ctx *Context, args *LookupSchematicsAgentOutputArgs, opts ...InvokeOption) LookupSchematicsAgentResultOutput

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

    public static class GetSchematicsAgent 
{
    public static Task<GetSchematicsAgentResult> InvokeAsync(GetSchematicsAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsAgentResult> Invoke(GetSchematicsAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchematicsAgentResult> getSchematicsAgent(GetSchematicsAgentArgs args, InvokeOptions options)
public static Output<GetSchematicsAgentResult> getSchematicsAgent(GetSchematicsAgentArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getSchematicsAgent:getSchematicsAgent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentId string
    Agent ID to get the details of agent.
    AgentId string
    Agent ID to get the details of agent.
    agentId String
    Agent ID to get the details of agent.
    agentId string
    Agent ID to get the details of agent.
    agent_id str
    Agent ID to get the details of agent.
    agentId String
    Agent ID to get the details of agent.

    getSchematicsAgent Result

    The following output properties are available:

    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentId string
    (String) Id of the agent.
    AgentInfrastructures List<GetSchematicsAgentAgentInfrastructure>
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentInputs List<GetSchematicsAgentAgentInput>
    AgentKpis List<GetSchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    AgentLocation string
    (String) The location where agent is deployed in the user environment.
    AgentMetadatas List<GetSchematicsAgentAgentMetadata>
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    CreatedAt string
    (String) The agent creation date-time.
    CreationBy string
    (String) The email address of an user who created the agent.
    Description string
    (String) Agent description.
    Id string
    (String) The agent resource id.
    Name string
    (String) The name of the agent (must be unique, for an account).
    RecentDeployJobs List<GetSchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs List<GetSchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs List<GetSchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    ResourceGroup string
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    SchematicsLocation string
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    SystemStates List<GetSchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    Tags List<string>
    (List) Tags for the agent.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    UserStates List<GetSchematicsAgentUserState>
    (List) User defined status of the agent. Nested scheme for user_state:
    Version string
    (String) Agent version.
    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentId string
    (String) Id of the agent.
    AgentInfrastructures []GetSchematicsAgentAgentInfrastructure
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentInputs []GetSchematicsAgentAgentInput
    AgentKpis []GetSchematicsAgentAgentKpi
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    AgentLocation string
    (String) The location where agent is deployed in the user environment.
    AgentMetadatas []GetSchematicsAgentAgentMetadata
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    CreatedAt string
    (String) The agent creation date-time.
    CreationBy string
    (String) The email address of an user who created the agent.
    Description string
    (String) Agent description.
    Id string
    (String) The agent resource id.
    Name string
    (String) The name of the agent (must be unique, for an account).
    RecentDeployJobs []GetSchematicsAgentRecentDeployJob
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs []GetSchematicsAgentRecentHealthJob
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs []GetSchematicsAgentRecentPrsJob
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    ResourceGroup string
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    SchematicsLocation string
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    SystemStates []GetSchematicsAgentSystemState
    (List) Computed state of the agent. Nested scheme for system_state:
    Tags []string
    (List) Tags for the agent.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    UserStates []GetSchematicsAgentUserState
    (List) User defined status of the agent. Nested scheme for user_state:
    Version string
    (String) Agent version.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentId String
    (String) Id of the agent.
    agentInfrastructures List<GetSchematicsAgentAgentInfrastructure>
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs List<GetSchematicsAgentAgentInput>
    agentKpis List<GetSchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation String
    (String) The location where agent is deployed in the user environment.
    agentMetadatas List<GetSchematicsAgentAgentMetadata>
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    createdAt String
    (String) The agent creation date-time.
    creationBy String
    (String) The email address of an user who created the agent.
    description String
    (String) Agent description.
    id String
    (String) The agent resource id.
    name String
    (String) The name of the agent (must be unique, for an account).
    recentDeployJobs List<GetSchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs List<GetSchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs List<GetSchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resourceGroup String
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation String
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    systemStates List<GetSchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    tags List<String>
    (List) Tags for the agent.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    userStates List<GetSchematicsAgentUserState>
    (List) User defined status of the agent. Nested scheme for user_state:
    version String
    (String) Agent version.
    agentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentId string
    (String) Id of the agent.
    agentInfrastructures GetSchematicsAgentAgentInfrastructure[]
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs GetSchematicsAgentAgentInput[]
    agentKpis GetSchematicsAgentAgentKpi[]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation string
    (String) The location where agent is deployed in the user environment.
    agentMetadatas GetSchematicsAgentAgentMetadata[]
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    createdAt string
    (String) The agent creation date-time.
    creationBy string
    (String) The email address of an user who created the agent.
    description string
    (String) Agent description.
    id string
    (String) The agent resource id.
    name string
    (String) The name of the agent (must be unique, for an account).
    recentDeployJobs GetSchematicsAgentRecentDeployJob[]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs GetSchematicsAgentRecentHealthJob[]
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs GetSchematicsAgentRecentPrsJob[]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resourceGroup string
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation string
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    systemStates GetSchematicsAgentSystemState[]
    (List) Computed state of the agent. Nested scheme for system_state:
    tags string[]
    (List) Tags for the agent.
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    userStates GetSchematicsAgentUserState[]
    (List) User defined status of the agent. Nested scheme for user_state:
    version string
    (String) Agent version.
    agent_crn str
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agent_id str
    (String) Id of the agent.
    agent_infrastructures Sequence[GetSchematicsAgentAgentInfrastructure]
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agent_inputs Sequence[GetSchematicsAgentAgentInput]
    agent_kpis Sequence[GetSchematicsAgentAgentKpi]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agent_location str
    (String) The location where agent is deployed in the user environment.
    agent_metadatas Sequence[GetSchematicsAgentAgentMetadata]
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    created_at str
    (String) The agent creation date-time.
    creation_by str
    (String) The email address of an user who created the agent.
    description str
    (String) Agent description.
    id str
    (String) The agent resource id.
    name str
    (String) The name of the agent (must be unique, for an account).
    recent_deploy_jobs Sequence[GetSchematicsAgentRecentDeployJob]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recent_health_jobs Sequence[GetSchematicsAgentRecentHealthJob]
    (List) Agent health check. Nested scheme for recent_health_job:
    recent_prs_jobs Sequence[GetSchematicsAgentRecentPrsJob]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resource_group str
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematics_location str
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    system_states Sequence[GetSchematicsAgentSystemState]
    (List) Computed state of the agent. Nested scheme for system_state:
    tags Sequence[str]
    (List) Tags for the agent.
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    user_states Sequence[GetSchematicsAgentUserState]
    (List) User defined status of the agent. Nested scheme for user_state:
    version str
    (String) Agent version.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentId String
    (String) Id of the agent.
    agentInfrastructures List<Property Map>
    (List) The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs List<Property Map>
    agentKpis List<Property Map>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation String
    (String) The location where agent is deployed in the user environment.
    agentMetadatas List<Property Map>
    (List) The metadata of an agent. Nested scheme for agent_metadata:
    createdAt String
    (String) The agent creation date-time.
    creationBy String
    (String) The email address of an user who created the agent.
    description String
    (String) Agent description.
    id String
    (String) The agent resource id.
    name String
    (String) The name of the agent (must be unique, for an account).
    recentDeployJobs List<Property Map>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs List<Property Map>
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs List<Property Map>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resourceGroup String
    (String) The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation String
    (String) List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de.
    systemStates List<Property Map>
    (List) Computed state of the agent. Nested scheme for system_state:
    tags List<String>
    (List) Tags for the agent.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    userStates List<Property Map>
    (List) User defined status of the agent. Nested scheme for user_state:
    version String
    (String) Agent version.

    Supporting Types

    GetSchematicsAgentAgentInfrastructure

    ClusterId string
    (String) The cluster ID where agent services will be running.
    ClusterResourceGroup string
    (String) The resource group of the cluster (is it required?).
    CosBucketName string
    (String) The COS bucket name used to store the logs.
    CosBucketRegion string
    (String) The COS bucket region.
    CosInstanceName string
    (String) The COS instance name to store the agent logs.
    InfraType string
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.
    ClusterId string
    (String) The cluster ID where agent services will be running.
    ClusterResourceGroup string
    (String) The resource group of the cluster (is it required?).
    CosBucketName string
    (String) The COS bucket name used to store the logs.
    CosBucketRegion string
    (String) The COS bucket region.
    CosInstanceName string
    (String) The COS instance name to store the agent logs.
    InfraType string
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.
    clusterId String
    (String) The cluster ID where agent services will be running.
    clusterResourceGroup String
    (String) The resource group of the cluster (is it required?).
    cosBucketName String
    (String) The COS bucket name used to store the logs.
    cosBucketRegion String
    (String) The COS bucket region.
    cosInstanceName String
    (String) The COS instance name to store the agent logs.
    infraType String
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.
    clusterId string
    (String) The cluster ID where agent services will be running.
    clusterResourceGroup string
    (String) The resource group of the cluster (is it required?).
    cosBucketName string
    (String) The COS bucket name used to store the logs.
    cosBucketRegion string
    (String) The COS bucket region.
    cosInstanceName string
    (String) The COS instance name to store the agent logs.
    infraType string
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.
    cluster_id str
    (String) The cluster ID where agent services will be running.
    cluster_resource_group str
    (String) The resource group of the cluster (is it required?).
    cos_bucket_name str
    (String) The COS bucket name used to store the logs.
    cos_bucket_region str
    (String) The COS bucket region.
    cos_instance_name str
    (String) The COS instance name to store the agent logs.
    infra_type str
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.
    clusterId String
    (String) The cluster ID where agent services will be running.
    clusterResourceGroup String
    (String) The resource group of the cluster (is it required?).
    cosBucketName String
    (String) The COS bucket name used to store the logs.
    cosBucketRegion String
    (String) The COS bucket region.
    cosInstanceName String
    (String) The COS instance name to store the agent logs.
    infraType String
    (String) Type of target agent infrastructure.

    • Constraints: Allowable values are: ibm_kubernetes, ibm_openshift, ibm_satellite.

    GetSchematicsAgentAgentInput

    Link string
    Metadatas List<GetSchematicsAgentAgentInputMetadata>
    Name string
    (String) The name of the agent (must be unique, for an account).
    UseDefault bool
    Value string
    (List) Value of the metadata name.
    Link string
    Metadatas []GetSchematicsAgentAgentInputMetadata
    Name string
    (String) The name of the agent (must be unique, for an account).
    UseDefault bool
    Value string
    (List) Value of the metadata name.
    link String
    metadatas List<GetSchematicsAgentAgentInputMetadata>
    name String
    (String) The name of the agent (must be unique, for an account).
    useDefault Boolean
    value String
    (List) Value of the metadata name.
    link string
    metadatas GetSchematicsAgentAgentInputMetadata[]
    name string
    (String) The name of the agent (must be unique, for an account).
    useDefault boolean
    value string
    (List) Value of the metadata name.
    link str
    metadatas Sequence[GetSchematicsAgentAgentInputMetadata]
    name str
    (String) The name of the agent (must be unique, for an account).
    use_default bool
    value str
    (List) Value of the metadata name.
    link String
    metadatas List<Property Map>
    name String
    (String) The name of the agent (must be unique, for an account).
    useDefault Boolean
    value String
    (List) Value of the metadata name.

    GetSchematicsAgentAgentInputMetadata

    Aliases List<string>
    CloudDataType string
    DefaultValue string
    Description string
    (String) Agent description.
    GroupBy string
    Hidden bool
    Immutable bool
    LinkStatus string
    Matches string
    MaxLength double
    MaxValue double
    MinLength double
    MinValue double
    Options List<string>
    Position double
    Required bool
    Secure bool
    Source string
    Type string
    Aliases []string
    CloudDataType string
    DefaultValue string
    Description string
    (String) Agent description.
    GroupBy string
    Hidden bool
    Immutable bool
    LinkStatus string
    Matches string
    MaxLength float64
    MaxValue float64
    MinLength float64
    MinValue float64
    Options []string
    Position float64
    Required bool
    Secure bool
    Source string
    Type string
    aliases List<String>
    cloudDataType String
    defaultValue String
    description String
    (String) Agent description.
    groupBy String
    hidden Boolean
    immutable Boolean
    linkStatus String
    matches String
    maxLength Double
    maxValue Double
    minLength Double
    minValue Double
    options List<String>
    position Double
    required Boolean
    secure Boolean
    source String
    type String
    aliases string[]
    cloudDataType string
    defaultValue string
    description string
    (String) Agent description.
    groupBy string
    hidden boolean
    immutable boolean
    linkStatus string
    matches string
    maxLength number
    maxValue number
    minLength number
    minValue number
    options string[]
    position number
    required boolean
    secure boolean
    source string
    type string
    aliases Sequence[str]
    cloud_data_type str
    default_value str
    description str
    (String) Agent description.
    group_by str
    hidden bool
    immutable bool
    link_status str
    matches str
    max_length float
    max_value float
    min_length float
    min_value float
    options Sequence[str]
    position float
    required bool
    secure bool
    source str
    type str
    aliases List<String>
    cloudDataType String
    defaultValue String
    description String
    (String) Agent description.
    groupBy String
    hidden Boolean
    immutable Boolean
    linkStatus String
    matches String
    maxLength Number
    maxValue Number
    minLength Number
    minValue Number
    options List<String>
    position Number
    required Boolean
    secure Boolean
    source String
    type String

    GetSchematicsAgentAgentKpi

    ApplicationIndicators List<ImmutableDictionary<string, string>>
    (List) Agent application key performance indicators.
    AvailabilityIndicator string
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    InfraIndicators List<ImmutableDictionary<string, string>>
    (List) Agent infrastructure key performance indicators.
    LifecycleIndicator string
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    PercentUsageIndicator string
    (String) Percentage usage of the agent resources.
    ApplicationIndicators []map[string]string
    (List) Agent application key performance indicators.
    AvailabilityIndicator string
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    InfraIndicators []map[string]string
    (List) Agent infrastructure key performance indicators.
    LifecycleIndicator string
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    PercentUsageIndicator string
    (String) Percentage usage of the agent resources.
    applicationIndicators List<Map<String,String>>
    (List) Agent application key performance indicators.
    availabilityIndicator String
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    infraIndicators List<Map<String,String>>
    (List) Agent infrastructure key performance indicators.
    lifecycleIndicator String
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    percentUsageIndicator String
    (String) Percentage usage of the agent resources.
    applicationIndicators {[key: string]: string}[]
    (List) Agent application key performance indicators.
    availabilityIndicator string
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    infraIndicators {[key: string]: string}[]
    (List) Agent infrastructure key performance indicators.
    lifecycleIndicator string
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    percentUsageIndicator string
    (String) Percentage usage of the agent resources.
    application_indicators Sequence[Mapping[str, str]]
    (List) Agent application key performance indicators.
    availability_indicator str
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    infra_indicators Sequence[Mapping[str, str]]
    (List) Agent infrastructure key performance indicators.
    lifecycle_indicator str
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    percent_usage_indicator str
    (String) Percentage usage of the agent resources.
    applicationIndicators List<Map<String>>
    (List) Agent application key performance indicators.
    availabilityIndicator String
    (String) Overall availability indicator reported by the agent.

    • Constraints: Allowable values are: available, unavailable, error.
    infraIndicators List<Map<String>>
    (List) Agent infrastructure key performance indicators.
    lifecycleIndicator String
    (String) Overall lifecycle indicator reported by the agents.

    • Constraints: Allowable values are: consistent, inconsistent, obselete.
    percentUsageIndicator String
    (String) Percentage usage of the agent resources.

    GetSchematicsAgentAgentMetadata

    Name string
    (String) The name of the agent (must be unique, for an account).
    Values List<string>
    (List) Value of the metadata name.
    Name string
    (String) The name of the agent (must be unique, for an account).
    Values []string
    (List) Value of the metadata name.
    name String
    (String) The name of the agent (must be unique, for an account).
    values List<String>
    (List) Value of the metadata name.
    name string
    (String) The name of the agent (must be unique, for an account).
    values string[]
    (List) Value of the metadata name.
    name str
    (String) The name of the agent (must be unique, for an account).
    values Sequence[str]
    (List) Value of the metadata name.
    name String
    (String) The name of the agent (must be unique, for an account).
    values List<String>
    (List) Value of the metadata name.

    GetSchematicsAgentRecentDeployJob

    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    IsRedeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    agentId string
    Agent ID to get the details of agent.
    agentVersion string
    (String) Agent version.
    isRedeployed boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full pre-requisite scanner job logs.
    statusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage string
    (String) The agent status message.
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    agent_id str
    Agent ID to get the details of agent.
    agent_version str
    (String) Agent version.
    is_redeployed bool
    (Boolean) True, when the same version of the agent was redeployed.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full pre-requisite scanner job logs.
    status_code str
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    status_message str
    (String) The agent status message.
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    isRedeployed Boolean
    (Boolean) True, when the same version of the agent was redeployed.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.

    GetSchematicsAgentRecentHealthJob

    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    agentId string
    Agent ID to get the details of agent.
    agentVersion string
    (String) Agent version.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full pre-requisite scanner job logs.
    statusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage string
    (String) The agent status message.
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    agent_id str
    Agent ID to get the details of agent.
    agent_version str
    (String) Agent version.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full pre-requisite scanner job logs.
    status_code str
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    status_message str
    (String) The agent status message.
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.

    GetSchematicsAgentRecentPrsJob

    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    AgentId string
    Agent ID to get the details of agent.
    AgentVersion string
    (String) Agent version.
    JobId string
    (String) Job Id.
    LogUrl string
    (String) URL to the full pre-requisite scanner job logs.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    agentId string
    Agent ID to get the details of agent.
    agentVersion string
    (String) Agent version.
    jobId string
    (String) Job Id.
    logUrl string
    (String) URL to the full pre-requisite scanner job logs.
    statusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage string
    (String) The agent status message.
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    agent_id str
    Agent ID to get the details of agent.
    agent_version str
    (String) Agent version.
    job_id str
    (String) Job Id.
    log_url str
    (String) URL to the full pre-requisite scanner job logs.
    status_code str
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    status_message str
    (String) The agent status message.
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    agentId String
    Agent ID to get the details of agent.
    agentVersion String
    (String) Agent version.
    jobId String
    (String) Job Id.
    logUrl String
    (String) URL to the full pre-requisite scanner job logs.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.

    GetSchematicsAgentSystemState

    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    StatusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    StatusMessage string
    (String) The agent status message.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.
    statusCode string
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage string
    (String) The agent status message.
    status_code str
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    status_message str
    (String) The agent status message.
    statusCode String
    (String) Agent Status.

    • Constraints: Allowable values are: error, normal, in_progress, pending, draft.
    statusMessage String
    (String) The agent status message.

    GetSchematicsAgentUserState

    SetAt string
    (String) When the User who set the state of the Object.
    SetBy string
    (String) Name of the User who set the state of the Object.
    State string
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.
    SetAt string
    (String) When the User who set the state of the Object.
    SetBy string
    (String) Name of the User who set the state of the Object.
    State string
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.
    setAt String
    (String) When the User who set the state of the Object.
    setBy String
    (String) Name of the User who set the state of the Object.
    state String
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.
    setAt string
    (String) When the User who set the state of the Object.
    setBy string
    (String) Name of the User who set the state of the Object.
    state string
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.
    set_at str
    (String) When the User who set the state of the Object.
    set_by str
    (String) Name of the User who set the state of the Object.
    state str
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.
    setAt String
    (String) When the User who set the state of the Object.
    setBy String
    (String) Name of the User who set the state of the Object.
    state String
    (String) User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm