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 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",
});
Copy
import pulumi
import pulumi_ibm as ibm

schematics_agent = ibm.get_schematics_agent(agent_id="agent_id")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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>
Copy
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]
Copy
func LookupSchematicsAgent(ctx *Context, args *LookupSchematicsAgentArgs, opts ...InvokeOption) (*LookupSchematicsAgentResult, error)
func LookupSchematicsAgentOutput(ctx *Context, args *LookupSchematicsAgentOutputArgs, opts ...InvokeOption) LookupSchematicsAgentResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSchematicsAgentResult> getSchematicsAgent(GetSchematicsAgentArgs args, InvokeOptions options)
public static Output<GetSchematicsAgentResult> getSchematicsAgent(GetSchematicsAgentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getSchematicsAgent:getSchematicsAgent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgentId This property is required. string
Agent ID to get the details of agent.
AgentId This property is required. string
Agent ID to get the details of agent.
agentId This property is required. String
Agent ID to get the details of agent.
agentId This property is required. string
Agent ID to get the details of agent.
agent_id This property is required. str
Agent ID to get the details of agent.
agentId This property is required. 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 This property is required. string
(String) The cluster ID where agent services will be running.
ClusterResourceGroup This property is required. string
(String) The resource group of the cluster (is it required?).
CosBucketName This property is required. string
(String) The COS bucket name used to store the logs.
CosBucketRegion This property is required. string
(String) The COS bucket region.
CosInstanceName This property is required. string
(String) The COS instance name to store the agent logs.
InfraType This property is required. string
(String) Type of target agent infrastructure.

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

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

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

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

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

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

GetSchematicsAgentAgentInput

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

GetSchematicsAgentAgentInputMetadata

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

GetSchematicsAgentAgentKpi

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

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

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

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

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

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

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

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

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

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

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

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

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

GetSchematicsAgentAgentMetadata

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

GetSchematicsAgentRecentDeployJob

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

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

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

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

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

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

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

GetSchematicsAgentRecentHealthJob

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

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

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

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

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

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

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

GetSchematicsAgentRecentPrsJob

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

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

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

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

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

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

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

GetSchematicsAgentSystemState

StatusCode This property is required. string
(String) Agent Status.

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

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

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

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

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

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

GetSchematicsAgentUserState

SetAt This property is required. string
(String) When the User who set the state of the Object.
SetBy This property is required. string
(String) Name of the User who set the state of the Object.
State This property is required. 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 This property is required. string
(String) When the User who set the state of the Object.
SetBy This property is required. string
(String) Name of the User who set the state of the Object.
State This property is required. 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 This property is required. String
(String) When the User who set the state of the Object.
setBy This property is required. String
(String) Name of the User who set the state of the Object.
state This property is required. 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 This property is required. string
(String) When the User who set the state of the Object.
setBy This property is required. string
(String) Name of the User who set the state of the Object.
state This property is required. 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 This property is required. str
(String) When the User who set the state of the Object.
set_by This property is required. str
(String) Name of the User who set the state of the Object.
state This property is required. 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 This property is required. String
(String) When the User who set the state of the Object.
setBy This property is required. String
(String) Name of the User who set the state of the Object.
state This property is required. 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm