1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSchematicsAgents
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSchematicsAgents

Get Started
ibm logo
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for schematics_agents. 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 schematicsAgents = ibm.getSchematicsAgents({
    name: "MyDevAgent",
});

    import pulumi
import pulumi_ibm as ibm

schematics_agents = ibm.get_schematics_agents(name="MyDevAgent")

    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.GetSchematicsAgents(ctx, &ibm.GetSchematicsAgentsArgs{
			Name: pulumi.StringRef("MyDevAgent"),
		}, 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 schematicsAgents = Ibm.GetSchematicsAgents.Invoke(new()
    {
        Name = "MyDevAgent",
    });

});

    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.GetSchematicsAgentsArgs;
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 schematicsAgents = IbmFunctions.getSchematicsAgents(GetSchematicsAgentsArgs.builder()
            .name("MyDevAgent")
            .build());

    }
}

    variables:
  schematicsAgents:
    fn::invoke:
      function: ibm:getSchematicsAgents
      arguments:
        name: MyDevAgent

    Using getSchematicsAgents

    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 getSchematicsAgents(args: GetSchematicsAgentsArgs, opts?: InvokeOptions): Promise<GetSchematicsAgentsResult>
function getSchematicsAgentsOutput(args: GetSchematicsAgentsOutputArgs, opts?: InvokeOptions): Output<GetSchematicsAgentsResult>
    def get_schematics_agents(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSchematicsAgentsResult
def get_schematics_agents_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsAgentsResult]
    func GetSchematicsAgents(ctx *Context, args *GetSchematicsAgentsArgs, opts ...InvokeOption) (*GetSchematicsAgentsResult, error)
func GetSchematicsAgentsOutput(ctx *Context, args *GetSchematicsAgentsOutputArgs, opts ...InvokeOption) GetSchematicsAgentsResultOutput

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

    public static class GetSchematicsAgents 
{
    public static Task<GetSchematicsAgentsResult> InvokeAsync(GetSchematicsAgentsArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsAgentsResult> Invoke(GetSchematicsAgentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchematicsAgentsResult> getSchematicsAgents(GetSchematicsAgentsArgs args, InvokeOptions options)
public static Output<GetSchematicsAgentsResult> getSchematicsAgents(GetSchematicsAgentsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    (String) The Agent registration id.
    Name string
    The name of the agent (must be unique, for an account).
    Id string
    (String) The Agent registration id.
    Name string
    The name of the agent (must be unique, for an account).
    id String
    (String) The Agent registration id.
    name String
    The name of the agent (must be unique, for an account).
    id string
    (String) The Agent registration id.
    name string
    The name of the agent (must be unique, for an account).
    id str
    (String) The Agent registration id.
    name str
    The name of the agent (must be unique, for an account).
    id String
    (String) The Agent registration id.
    name String
    The name of the agent (must be unique, for an account).

    getSchematicsAgents Result

    The following output properties are available:

    Agents List<GetSchematicsAgentsAgent>
    (List) The list of agents in the account. Nested scheme for agents:
    Id string
    (String) The Agent registration id.
    Limit double
    (Integer) The number of records returned.
    Offset double
    (Integer) The skipped number of records.
    TotalCount double
    (Integer) The total number of records.
    Name string
    (String) The name of the agent.
    Agents []GetSchematicsAgentsAgent
    (List) The list of agents in the account. Nested scheme for agents:
    Id string
    (String) The Agent registration id.
    Limit float64
    (Integer) The number of records returned.
    Offset float64
    (Integer) The skipped number of records.
    TotalCount float64
    (Integer) The total number of records.
    Name string
    (String) The name of the agent.
    agents List<GetSchematicsAgentsAgent>
    (List) The list of agents in the account. Nested scheme for agents:
    id String
    (String) The Agent registration id.
    limit Double
    (Integer) The number of records returned.
    offset Double
    (Integer) The skipped number of records.
    totalCount Double
    (Integer) The total number of records.
    name String
    (String) The name of the agent.
    agents GetSchematicsAgentsAgent[]
    (List) The list of agents in the account. Nested scheme for agents:
    id string
    (String) The Agent registration id.
    limit number
    (Integer) The number of records returned.
    offset number
    (Integer) The skipped number of records.
    totalCount number
    (Integer) The total number of records.
    name string
    (String) The name of the agent.
    agents Sequence[GetSchematicsAgentsAgent]
    (List) The list of agents in the account. Nested scheme for agents:
    id str
    (String) The Agent registration id.
    limit float
    (Integer) The number of records returned.
    offset float
    (Integer) The skipped number of records.
    total_count float
    (Integer) The total number of records.
    name str
    (String) The name of the agent.
    agents List<Property Map>
    (List) The list of agents in the account. Nested scheme for agents:
    id String
    (String) The Agent registration id.
    limit Number
    (Integer) The number of records returned.
    offset Number
    (Integer) The skipped number of records.
    totalCount Number
    (Integer) The total number of records.
    name String
    (String) The name of the agent.

    Supporting Types

    GetSchematicsAgentsAgent

    AgentCrn string
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    AgentLocation string
    (String) The location where agent is deployed in the user environment.
    ConnectionStates List<GetSchematicsAgentsAgentConnectionState>
    (List) Connection status of the agent. Nested scheme for connection_state:
    Description string
    (String) Agent description.
    Id string
    (String) The Agent registration id.
    Location 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.
    Name string
    The name of the agent (must be unique, for an account).
    ProfileId string
    (String) The IAM trusted profile id, used by the Agent instance.
    RegisteredAt string
    (String) The Agent registration date-time.
    RegisteredBy string
    (String) The email address of an user who registered the Agent.
    ResourceGroup string
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    SystemStates List<GetSchematicsAgentsAgentSystemState>
    (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<GetSchematicsAgentsAgentUserState>
    (List) User defined status of the agent. Nested scheme for user_state:
    AgentCrn string
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    AgentLocation string
    (String) The location where agent is deployed in the user environment.
    ConnectionStates []GetSchematicsAgentsAgentConnectionState
    (List) Connection status of the agent. Nested scheme for connection_state:
    Description string
    (String) Agent description.
    Id string
    (String) The Agent registration id.
    Location 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.
    Name string
    The name of the agent (must be unique, for an account).
    ProfileId string
    (String) The IAM trusted profile id, used by the Agent instance.
    RegisteredAt string
    (String) The Agent registration date-time.
    RegisteredBy string
    (String) The email address of an user who registered the Agent.
    ResourceGroup string
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    SystemStates []GetSchematicsAgentsAgentSystemState
    (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 []GetSchematicsAgentsAgentUserState
    (List) User defined status of the agent. Nested scheme for user_state:
    agentCrn String
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    agentLocation String
    (String) The location where agent is deployed in the user environment.
    connectionStates List<GetSchematicsAgentsAgentConnectionState>
    (List) Connection status of the agent. Nested scheme for connection_state:
    description String
    (String) Agent description.
    id String
    (String) The Agent registration id.
    location 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.
    name String
    The name of the agent (must be unique, for an account).
    profileId String
    (String) The IAM trusted profile id, used by the Agent instance.
    registeredAt String
    (String) The Agent registration date-time.
    registeredBy String
    (String) The email address of an user who registered the Agent.
    resourceGroup String
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    systemStates List<GetSchematicsAgentsAgentSystemState>
    (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<GetSchematicsAgentsAgentUserState>
    (List) User defined status of the agent. Nested scheme for user_state:
    agentCrn string
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    agentLocation string
    (String) The location where agent is deployed in the user environment.
    connectionStates GetSchematicsAgentsAgentConnectionState[]
    (List) Connection status of the agent. Nested scheme for connection_state:
    description string
    (String) Agent description.
    id string
    (String) The Agent registration id.
    location 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.
    name string
    The name of the agent (must be unique, for an account).
    profileId string
    (String) The IAM trusted profile id, used by the Agent instance.
    registeredAt string
    (String) The Agent registration date-time.
    registeredBy string
    (String) The email address of an user who registered the Agent.
    resourceGroup string
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    systemStates GetSchematicsAgentsAgentSystemState[]
    (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 GetSchematicsAgentsAgentUserState[]
    (List) User defined status of the agent. Nested scheme for user_state:
    agent_crn str
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    agent_location str
    (String) The location where agent is deployed in the user environment.
    connection_states Sequence[GetSchematicsAgentsAgentConnectionState]
    (List) Connection status of the agent. Nested scheme for connection_state:
    description str
    (String) Agent description.
    id str
    (String) The Agent registration id.
    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.
    name str
    The name of the agent (must be unique, for an account).
    profile_id str
    (String) The IAM trusted profile id, used by the Agent instance.
    registered_at str
    (String) The Agent registration date-time.
    registered_by str
    (String) The email address of an user who registered the Agent.
    resource_group str
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    system_states Sequence[GetSchematicsAgentsAgentSystemState]
    (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[GetSchematicsAgentsAgentUserState]
    (List) User defined status of the agent. Nested scheme for user_state:
    agentCrn String
    (String) The Agent crn, obtained from the Schematics Agent deployment configuration.
    agentLocation String
    (String) The location where agent is deployed in the user environment.
    connectionStates List<Property Map>
    (List) Connection status of the agent. Nested scheme for connection_state:
    description String
    (String) Agent description.
    id String
    (String) The Agent registration id.
    location 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.
    name String
    The name of the agent (must be unique, for an account).
    profileId String
    (String) The IAM trusted profile id, used by the Agent instance.
    registeredAt String
    (String) The Agent registration date-time.
    registeredBy String
    (String) The email address of an user who registered the Agent.
    resourceGroup String
    (String) The resource-group name for the agent. By default, Agent will be registered in Default Resource Group.
    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:

    GetSchematicsAgentsAgentConnectionState

    CheckedAt string
    (String) When the connection state is modified.
    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.
    CheckedAt string
    (String) When the connection state is modified.
    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.
    checkedAt String
    (String) When the connection state is modified.
    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.
    checkedAt string
    (String) When the connection state is modified.
    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.
    checked_at str
    (String) When the connection state is modified.
    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.
    checkedAt String
    (String) When the connection state is modified.
    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.

    GetSchematicsAgentsAgentSystemState

    Message string
    (String) The Agent status message.
    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.
    Message string
    (String) The Agent status message.
    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.
    message String
    (String) The Agent status message.
    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.
    message string
    (String) The Agent status message.
    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.
    message str
    (String) The Agent status message.
    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.
    message String
    (String) The Agent status message.
    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.

    GetSchematicsAgentsAgentUserState

    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.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate