Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SchematicsAgent
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SchematicsAgent

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a resource for schematics_agent. This allows schematics_agent to be created, updated and deleted.

    Example Usage

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

const schematicsAgentInstance = new ibm.SchematicsAgent("schematicsAgentInstance", {
    agentInfrastructure: {
        clusterId: "cluster_id",
        clusterResourceGroup: "cluster_resource_group",
        cosBucketName: "cos_bucket_name",
        cosBucketRegion: "cos_bucket_region",
        cosInstanceName: "cos_instance_name",
        infraType: "ibm_kubernetes",
    },
    agentLocation: "us-south",
    agentMetadatas: [{
        name: "purpose",
        values: [
            "git",
            "terraform",
            "ansible",
        ],
    }],
    description: "Create Agent",
    resourceGroup: "Default",
    runDestroyResources: 1,
    schematicsLocation: "us-south",
    tags: ["agent-MyDevAgent"],
    version: "1.0.0",
});

    import pulumi
import pulumi_ibm as ibm

schematics_agent_instance = ibm.SchematicsAgent("schematicsAgentInstance",
    agent_infrastructure={
        "cluster_id": "cluster_id",
        "cluster_resource_group": "cluster_resource_group",
        "cos_bucket_name": "cos_bucket_name",
        "cos_bucket_region": "cos_bucket_region",
        "cos_instance_name": "cos_instance_name",
        "infra_type": "ibm_kubernetes",
    },
    agent_location="us-south",
    agent_metadatas=[{
        "name": "purpose",
        "values": [
            "git",
            "terraform",
            "ansible",
        ],
    }],
    description="Create Agent",
    resource_group="Default",
    run_destroy_resources=1,
    schematics_location="us-south",
    tags=["agent-MyDevAgent"],
    version="1.0.0")

    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.NewSchematicsAgent(ctx, "schematicsAgentInstance", &ibm.SchematicsAgentArgs{
			AgentInfrastructure: &ibm.SchematicsAgentAgentInfrastructureArgs{
				ClusterId:            pulumi.String("cluster_id"),
				ClusterResourceGroup: pulumi.String("cluster_resource_group"),
				CosBucketName:        pulumi.String("cos_bucket_name"),
				CosBucketRegion:      pulumi.String("cos_bucket_region"),
				CosInstanceName:      pulumi.String("cos_instance_name"),
				InfraType:            pulumi.String("ibm_kubernetes"),
			},
			AgentLocation: pulumi.String("us-south"),
			AgentMetadatas: ibm.SchematicsAgentAgentMetadataArray{
				&ibm.SchematicsAgentAgentMetadataArgs{
					Name: pulumi.String("purpose"),
					Values: pulumi.StringArray{
						pulumi.String("git"),
						pulumi.String("terraform"),
						pulumi.String("ansible"),
					},
				},
			},
			Description:         pulumi.String("Create Agent"),
			ResourceGroup:       pulumi.String("Default"),
			RunDestroyResources: pulumi.Float64(1),
			SchematicsLocation:  pulumi.String("us-south"),
			Tags: pulumi.StringArray{
				pulumi.String("agent-MyDevAgent"),
			},
			Version: pulumi.String("1.0.0"),
		})
		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 schematicsAgentInstance = new Ibm.SchematicsAgent("schematicsAgentInstance", new()
    {
        AgentInfrastructure = new Ibm.Inputs.SchematicsAgentAgentInfrastructureArgs
        {
            ClusterId = "cluster_id",
            ClusterResourceGroup = "cluster_resource_group",
            CosBucketName = "cos_bucket_name",
            CosBucketRegion = "cos_bucket_region",
            CosInstanceName = "cos_instance_name",
            InfraType = "ibm_kubernetes",
        },
        AgentLocation = "us-south",
        AgentMetadatas = new[]
        {
            new Ibm.Inputs.SchematicsAgentAgentMetadataArgs
            {
                Name = "purpose",
                Values = new[]
                {
                    "git",
                    "terraform",
                    "ansible",
                },
            },
        },
        Description = "Create Agent",
        ResourceGroup = "Default",
        RunDestroyResources = 1,
        SchematicsLocation = "us-south",
        Tags = new[]
        {
            "agent-MyDevAgent",
        },
        Version = "1.0.0",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SchematicsAgent;
import com.pulumi.ibm.SchematicsAgentArgs;
import com.pulumi.ibm.inputs.SchematicsAgentAgentInfrastructureArgs;
import com.pulumi.ibm.inputs.SchematicsAgentAgentMetadataArgs;
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) {
        var schematicsAgentInstance = new SchematicsAgent("schematicsAgentInstance", SchematicsAgentArgs.builder()
            .agentInfrastructure(SchematicsAgentAgentInfrastructureArgs.builder()
                .clusterId("cluster_id")
                .clusterResourceGroup("cluster_resource_group")
                .cosBucketName("cos_bucket_name")
                .cosBucketRegion("cos_bucket_region")
                .cosInstanceName("cos_instance_name")
                .infraType("ibm_kubernetes")
                .build())
            .agentLocation("us-south")
            .agentMetadatas(SchematicsAgentAgentMetadataArgs.builder()
                .name("purpose")
                .values(                
                    "git",
                    "terraform",
                    "ansible")
                .build())
            .description("Create Agent")
            .resourceGroup("Default")
            .runDestroyResources(1)
            .schematicsLocation("us-south")
            .tags("agent-MyDevAgent")
            .version("1.0.0")
            .build());

    }
}

    resources:
  schematicsAgentInstance:
    type: ibm:SchematicsAgent
    properties:
      agentInfrastructure:
        clusterId: cluster_id
        clusterResourceGroup: cluster_resource_group
        cosBucketName: cos_bucket_name
        cosBucketRegion: cos_bucket_region
        cosInstanceName: cos_instance_name
        infraType: ibm_kubernetes
      agentLocation: us-south
      agentMetadatas:
        - name: purpose
          values:
            - git
            - terraform
            - ansible
      description: Create Agent
      resourceGroup: Default
      runDestroyResources: 1
      schematicsLocation: us-south
      tags:
        - agent-MyDevAgent
      version: 1.0.0

    Create SchematicsAgent Resource

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

    Constructor syntax

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

@overload
def SchematicsAgent(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    schematics_location: Optional[str] = None,
                    resource_group: Optional[str] = None,
                    agent_location: Optional[str] = None,
                    version: Optional[str] = None,
                    agent_infrastructure: Optional[SchematicsAgentAgentInfrastructureArgs] = None,
                    user_state: Optional[SchematicsAgentUserStateArgs] = None,
                    schematics_agent_id: Optional[str] = None,
                    name: Optional[str] = None,
                    agent_inputs: Optional[Sequence[SchematicsAgentAgentInputArgs]] = None,
                    description: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None,
                    timeouts: Optional[SchematicsAgentTimeoutsArgs] = None,
                    run_destroy_resources: Optional[float] = None,
                    agent_metadatas: Optional[Sequence[SchematicsAgentAgentMetadataArgs]] = None)
    func NewSchematicsAgent(ctx *Context, name string, args SchematicsAgentArgs, opts ...ResourceOption) (*SchematicsAgent, error)
    public SchematicsAgent(string name, SchematicsAgentArgs args, CustomResourceOptions? opts = null)
    public SchematicsAgent(String name, SchematicsAgentArgs args)
public SchematicsAgent(String name, SchematicsAgentArgs args, CustomResourceOptions options)

    type: ibm:SchematicsAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

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

    var schematicsAgentResource = new Ibm.SchematicsAgent("schematicsAgentResource", new()
{
    SchematicsLocation = "string",
    ResourceGroup = "string",
    AgentLocation = "string",
    Version = "string",
    AgentInfrastructure = new Ibm.Inputs.SchematicsAgentAgentInfrastructureArgs
    {
        ClusterId = "string",
        ClusterResourceGroup = "string",
        CosBucketName = "string",
        CosBucketRegion = "string",
        CosInstanceName = "string",
        InfraType = "string",
    },
    UserState = new Ibm.Inputs.SchematicsAgentUserStateArgs
    {
        SetAt = "string",
        SetBy = "string",
        State = "string",
    },
    SchematicsAgentId = "string",
    Name = "string",
    AgentInputs = new[]
    {
        new Ibm.Inputs.SchematicsAgentAgentInputArgs
        {
            Link = "string",
            Metadata = new Ibm.Inputs.SchematicsAgentAgentInputMetadataArgs
            {
                Aliases = new[]
                {
                    "string",
                },
                CloudDataType = "string",
                DefaultValue = "string",
                Description = "string",
                GroupBy = "string",
                Hidden = false,
                Immutable = false,
                LinkStatus = "string",
                Matches = "string",
                MaxLength = 0,
                MaxValue = 0,
                MinLength = 0,
                MinValue = 0,
                Options = new[]
                {
                    "string",
                },
                Position = 0,
                Required = false,
                Secure = false,
                Source = "string",
                Type = "string",
            },
            Name = "string",
            UseDefault = false,
            Value = "string",
        },
    },
    Description = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.SchematicsAgentTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    RunDestroyResources = 0,
    AgentMetadatas = new[]
    {
        new Ibm.Inputs.SchematicsAgentAgentMetadataArgs
        {
            Name = "string",
            Values = new[]
            {
                "string",
            },
        },
    },
});

    example, err := ibm.NewSchematicsAgent(ctx, "schematicsAgentResource", &ibm.SchematicsAgentArgs{
	SchematicsLocation: pulumi.String("string"),
	ResourceGroup:      pulumi.String("string"),
	AgentLocation:      pulumi.String("string"),
	Version:            pulumi.String("string"),
	AgentInfrastructure: &ibm.SchematicsAgentAgentInfrastructureArgs{
		ClusterId:            pulumi.String("string"),
		ClusterResourceGroup: pulumi.String("string"),
		CosBucketName:        pulumi.String("string"),
		CosBucketRegion:      pulumi.String("string"),
		CosInstanceName:      pulumi.String("string"),
		InfraType:            pulumi.String("string"),
	},
	UserState: &ibm.SchematicsAgentUserStateArgs{
		SetAt: pulumi.String("string"),
		SetBy: pulumi.String("string"),
		State: pulumi.String("string"),
	},
	SchematicsAgentId: pulumi.String("string"),
	Name:              pulumi.String("string"),
	AgentInputs: ibm.SchematicsAgentAgentInputArray{
		&ibm.SchematicsAgentAgentInputArgs{
			Link: pulumi.String("string"),
			Metadata: &ibm.SchematicsAgentAgentInputMetadataArgs{
				Aliases: pulumi.StringArray{
					pulumi.String("string"),
				},
				CloudDataType: pulumi.String("string"),
				DefaultValue:  pulumi.String("string"),
				Description:   pulumi.String("string"),
				GroupBy:       pulumi.String("string"),
				Hidden:        pulumi.Bool(false),
				Immutable:     pulumi.Bool(false),
				LinkStatus:    pulumi.String("string"),
				Matches:       pulumi.String("string"),
				MaxLength:     pulumi.Float64(0),
				MaxValue:      pulumi.Float64(0),
				MinLength:     pulumi.Float64(0),
				MinValue:      pulumi.Float64(0),
				Options: pulumi.StringArray{
					pulumi.String("string"),
				},
				Position: pulumi.Float64(0),
				Required: pulumi.Bool(false),
				Secure:   pulumi.Bool(false),
				Source:   pulumi.String("string"),
				Type:     pulumi.String("string"),
			},
			Name:       pulumi.String("string"),
			UseDefault: pulumi.Bool(false),
			Value:      pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.SchematicsAgentTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	RunDestroyResources: pulumi.Float64(0),
	AgentMetadatas: ibm.SchematicsAgentAgentMetadataArray{
		&ibm.SchematicsAgentAgentMetadataArgs{
			Name: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    var schematicsAgentResource = new SchematicsAgent("schematicsAgentResource", SchematicsAgentArgs.builder()
    .schematicsLocation("string")
    .resourceGroup("string")
    .agentLocation("string")
    .version("string")
    .agentInfrastructure(SchematicsAgentAgentInfrastructureArgs.builder()
        .clusterId("string")
        .clusterResourceGroup("string")
        .cosBucketName("string")
        .cosBucketRegion("string")
        .cosInstanceName("string")
        .infraType("string")
        .build())
    .userState(SchematicsAgentUserStateArgs.builder()
        .setAt("string")
        .setBy("string")
        .state("string")
        .build())
    .schematicsAgentId("string")
    .name("string")
    .agentInputs(SchematicsAgentAgentInputArgs.builder()
        .link("string")
        .metadata(SchematicsAgentAgentInputMetadataArgs.builder()
            .aliases("string")
            .cloudDataType("string")
            .defaultValue("string")
            .description("string")
            .groupBy("string")
            .hidden(false)
            .immutable(false)
            .linkStatus("string")
            .matches("string")
            .maxLength(0)
            .maxValue(0)
            .minLength(0)
            .minValue(0)
            .options("string")
            .position(0)
            .required(false)
            .secure(false)
            .source("string")
            .type("string")
            .build())
        .name("string")
        .useDefault(false)
        .value("string")
        .build())
    .description("string")
    .tags("string")
    .timeouts(SchematicsAgentTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .runDestroyResources(0)
    .agentMetadatas(SchematicsAgentAgentMetadataArgs.builder()
        .name("string")
        .values("string")
        .build())
    .build());

    schematics_agent_resource = ibm.SchematicsAgent("schematicsAgentResource",
    schematics_location="string",
    resource_group="string",
    agent_location="string",
    version="string",
    agent_infrastructure={
        "cluster_id": "string",
        "cluster_resource_group": "string",
        "cos_bucket_name": "string",
        "cos_bucket_region": "string",
        "cos_instance_name": "string",
        "infra_type": "string",
    },
    user_state={
        "set_at": "string",
        "set_by": "string",
        "state": "string",
    },
    schematics_agent_id="string",
    name="string",
    agent_inputs=[{
        "link": "string",
        "metadata": {
            "aliases": ["string"],
            "cloud_data_type": "string",
            "default_value": "string",
            "description": "string",
            "group_by": "string",
            "hidden": False,
            "immutable": False,
            "link_status": "string",
            "matches": "string",
            "max_length": 0,
            "max_value": 0,
            "min_length": 0,
            "min_value": 0,
            "options": ["string"],
            "position": 0,
            "required": False,
            "secure": False,
            "source": "string",
            "type": "string",
        },
        "name": "string",
        "use_default": False,
        "value": "string",
    }],
    description="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    run_destroy_resources=0,
    agent_metadatas=[{
        "name": "string",
        "values": ["string"],
    }])

    const schematicsAgentResource = new ibm.SchematicsAgent("schematicsAgentResource", {
    schematicsLocation: "string",
    resourceGroup: "string",
    agentLocation: "string",
    version: "string",
    agentInfrastructure: {
        clusterId: "string",
        clusterResourceGroup: "string",
        cosBucketName: "string",
        cosBucketRegion: "string",
        cosInstanceName: "string",
        infraType: "string",
    },
    userState: {
        setAt: "string",
        setBy: "string",
        state: "string",
    },
    schematicsAgentId: "string",
    name: "string",
    agentInputs: [{
        link: "string",
        metadata: {
            aliases: ["string"],
            cloudDataType: "string",
            defaultValue: "string",
            description: "string",
            groupBy: "string",
            hidden: false,
            immutable: false,
            linkStatus: "string",
            matches: "string",
            maxLength: 0,
            maxValue: 0,
            minLength: 0,
            minValue: 0,
            options: ["string"],
            position: 0,
            required: false,
            secure: false,
            source: "string",
            type: "string",
        },
        name: "string",
        useDefault: false,
        value: "string",
    }],
    description: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    runDestroyResources: 0,
    agentMetadatas: [{
        name: "string",
        values: ["string"],
    }],
});

    type: ibm:SchematicsAgent
properties:
    agentInfrastructure:
        clusterId: string
        clusterResourceGroup: string
        cosBucketName: string
        cosBucketRegion: string
        cosInstanceName: string
        infraType: string
    agentInputs:
        - link: string
          metadata:
            aliases:
                - string
            cloudDataType: string
            defaultValue: string
            description: string
            groupBy: string
            hidden: false
            immutable: false
            linkStatus: string
            matches: string
            maxLength: 0
            maxValue: 0
            minLength: 0
            minValue: 0
            options:
                - string
            position: 0
            required: false
            secure: false
            source: string
            type: string
          name: string
          useDefault: false
          value: string
    agentLocation: string
    agentMetadatas:
        - name: string
          values:
            - string
    description: string
    name: string
    resourceGroup: string
    runDestroyResources: 0
    schematicsAgentId: string
    schematicsLocation: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
    userState:
        setAt: string
        setBy: string
        state: string
    version: string

    SchematicsAgent Resource Properties

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

    Inputs

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

    The SchematicsAgent resource accepts the following input properties:

    AgentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentLocation string
    The location where agent is deployed in the user environment.
    ResourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    SchematicsLocation 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.
    Version string
    Agent version.
    AgentInputs List<SchematicsAgentAgentInput>
    Additional input variables for the agent.
    AgentMetadatas List<SchematicsAgentAgentMetadata>
    The metadata of an agent. Nested scheme for agent_metadata:
    Description string
    Agent description.
    Name string
    The name of the agent (must be unique, for an account).
    RunDestroyResources double
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    SchematicsAgentId string
    The unique identifier of the schematics_agent.
    Tags List<string>
    Tags for the agent.
    Timeouts SchematicsAgentTimeouts
    UserState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    AgentInfrastructure SchematicsAgentAgentInfrastructureArgs
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentLocation string
    The location where agent is deployed in the user environment.
    ResourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    SchematicsLocation 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.
    Version string
    Agent version.
    AgentInputs []SchematicsAgentAgentInputArgs
    Additional input variables for the agent.
    AgentMetadatas []SchematicsAgentAgentMetadataArgs
    The metadata of an agent. Nested scheme for agent_metadata:
    Description string
    Agent description.
    Name string
    The name of the agent (must be unique, for an account).
    RunDestroyResources float64
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    SchematicsAgentId string
    The unique identifier of the schematics_agent.
    Tags []string
    Tags for the agent.
    Timeouts SchematicsAgentTimeoutsArgs
    UserState SchematicsAgentUserStateArgs
    User defined status of the agent. Nested scheme for user_state:
    agentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentLocation String
    The location where agent is deployed in the user environment.
    resourceGroup String
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation 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.
    version String
    Agent version.
    agentInputs List<SchematicsAgentAgentInput>
    Additional input variables for the agent.
    agentMetadatas List<SchematicsAgentAgentMetadata>
    The metadata of an agent. Nested scheme for agent_metadata:
    description String
    Agent description.
    name String
    The name of the agent (must be unique, for an account).
    runDestroyResources Double
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId String
    The unique identifier of the schematics_agent.
    tags List<String>
    Tags for the agent.
    timeouts SchematicsAgentTimeouts
    userState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    agentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentLocation string
    The location where agent is deployed in the user environment.
    resourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation 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.
    version string
    Agent version.
    agentInputs SchematicsAgentAgentInput[]
    Additional input variables for the agent.
    agentMetadatas SchematicsAgentAgentMetadata[]
    The metadata of an agent. Nested scheme for agent_metadata:
    description string
    Agent description.
    name string
    The name of the agent (must be unique, for an account).
    runDestroyResources number
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId string
    The unique identifier of the schematics_agent.
    tags string[]
    Tags for the agent.
    timeouts SchematicsAgentTimeouts
    userState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    agent_infrastructure SchematicsAgentAgentInfrastructureArgs
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agent_location str
    The location where agent is deployed in the user environment.
    resource_group str
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematics_location str
    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.
    version str
    Agent version.
    agent_inputs Sequence[SchematicsAgentAgentInputArgs]
    Additional input variables for the agent.
    agent_metadatas Sequence[SchematicsAgentAgentMetadataArgs]
    The metadata of an agent. Nested scheme for agent_metadata:
    description str
    Agent description.
    name str
    The name of the agent (must be unique, for an account).
    run_destroy_resources float
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematics_agent_id str
    The unique identifier of the schematics_agent.
    tags Sequence[str]
    Tags for the agent.
    timeouts SchematicsAgentTimeoutsArgs
    user_state SchematicsAgentUserStateArgs
    User defined status of the agent. Nested scheme for user_state:
    agentInfrastructure Property Map
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentLocation String
    The location where agent is deployed in the user environment.
    resourceGroup String
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    schematicsLocation 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.
    version String
    Agent version.
    agentInputs List<Property Map>
    Additional input variables for the agent.
    agentMetadatas List<Property Map>
    The metadata of an agent. Nested scheme for agent_metadata:
    description String
    Agent description.
    name String
    The name of the agent (must be unique, for an account).
    runDestroyResources Number
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId String
    The unique identifier of the schematics_agent.
    tags List<String>
    Tags for the agent.
    timeouts Property Map
    userState Property Map
    User defined status of the agent. Nested scheme for user_state:

    Outputs

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

    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentKpis List<SchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    CreatedAt string
    (String) The agent creation date-time.
    CreationBy string
    (String) The email address of an user who created the agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    RecentDeployJobs List<SchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs List<SchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs List<SchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    SystemStates List<SchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentKpis []SchematicsAgentAgentKpi
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    CreatedAt string
    (String) The agent creation date-time.
    CreationBy string
    (String) The email address of an user who created the agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    RecentDeployJobs []SchematicsAgentRecentDeployJob
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs []SchematicsAgentRecentHealthJob
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs []SchematicsAgentRecentPrsJob
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    SystemStates []SchematicsAgentSystemState
    (List) Computed state of the agent. Nested scheme for system_state:
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentKpis List<SchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    createdAt String
    (String) The agent creation date-time.
    creationBy String
    (String) The email address of an user who created the agent.
    id String
    The provider-assigned unique ID for this managed resource.
    recentDeployJobs List<SchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs List<SchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs List<SchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    systemStates List<SchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    agentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentKpis SchematicsAgentAgentKpi[]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    createdAt string
    (String) The agent creation date-time.
    creationBy string
    (String) The email address of an user who created the agent.
    id string
    The provider-assigned unique ID for this managed resource.
    recentDeployJobs SchematicsAgentRecentDeployJob[]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs SchematicsAgentRecentHealthJob[]
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs SchematicsAgentRecentPrsJob[]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    systemStates SchematicsAgentSystemState[]
    (List) Computed state of the agent. Nested scheme for system_state:
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    agent_crn str
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agent_kpis Sequence[SchematicsAgentAgentKpi]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    created_at str
    (String) The agent creation date-time.
    creation_by str
    (String) The email address of an user who created the agent.
    id str
    The provider-assigned unique ID for this managed resource.
    recent_deploy_jobs Sequence[SchematicsAgentRecentDeployJob]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recent_health_jobs Sequence[SchematicsAgentRecentHealthJob]
    (List) Agent health check. Nested scheme for recent_health_job:
    recent_prs_jobs Sequence[SchematicsAgentRecentPrsJob]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    system_states Sequence[SchematicsAgentSystemState]
    (List) Computed state of the agent. Nested scheme for system_state:
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentKpis List<Property Map>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    createdAt String
    (String) The agent creation date-time.
    creationBy String
    (String) The email address of an user who created the agent.
    id String
    The provider-assigned unique ID for this managed resource.
    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:
    systemStates List<Property Map>
    (List) Computed state of the agent. Nested scheme for system_state:
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.

    Look up Existing SchematicsAgent Resource

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

    public static get(name: string, id: Input<ID>, state?: SchematicsAgentState, opts?: CustomResourceOptions): SchematicsAgent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_crn: Optional[str] = None,
        agent_infrastructure: Optional[SchematicsAgentAgentInfrastructureArgs] = None,
        agent_inputs: Optional[Sequence[SchematicsAgentAgentInputArgs]] = None,
        agent_kpis: Optional[Sequence[SchematicsAgentAgentKpiArgs]] = None,
        agent_location: Optional[str] = None,
        agent_metadatas: Optional[Sequence[SchematicsAgentAgentMetadataArgs]] = None,
        created_at: Optional[str] = None,
        creation_by: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        recent_deploy_jobs: Optional[Sequence[SchematicsAgentRecentDeployJobArgs]] = None,
        recent_health_jobs: Optional[Sequence[SchematicsAgentRecentHealthJobArgs]] = None,
        recent_prs_jobs: Optional[Sequence[SchematicsAgentRecentPrsJobArgs]] = None,
        resource_group: Optional[str] = None,
        run_destroy_resources: Optional[float] = None,
        schematics_agent_id: Optional[str] = None,
        schematics_location: Optional[str] = None,
        system_states: Optional[Sequence[SchematicsAgentSystemStateArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[SchematicsAgentTimeoutsArgs] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        user_state: Optional[SchematicsAgentUserStateArgs] = None,
        version: Optional[str] = None) -> SchematicsAgent
    func GetSchematicsAgent(ctx *Context, name string, id IDInput, state *SchematicsAgentState, opts ...ResourceOption) (*SchematicsAgent, error)
    public static SchematicsAgent Get(string name, Input<string> id, SchematicsAgentState? state, CustomResourceOptions? opts = null)
    public static SchematicsAgent get(String name, Output<String> id, SchematicsAgentState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SchematicsAgent    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentInputs List<SchematicsAgentAgentInput>
    Additional input variables for the agent.
    AgentKpis List<SchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    AgentLocation string
    The location where agent is deployed in the user environment.
    AgentMetadatas List<SchematicsAgentAgentMetadata>
    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
    Agent description.
    Name string
    The name of the agent (must be unique, for an account).
    RecentDeployJobs List<SchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs List<SchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs List<SchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    ResourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    RunDestroyResources double
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    SchematicsAgentId string
    The unique identifier of the schematics_agent.
    SchematicsLocation 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<SchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    Tags List<string>
    Tags for the agent.
    Timeouts SchematicsAgentTimeouts
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    UserState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    Version string
    Agent version.
    AgentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    AgentInfrastructure SchematicsAgentAgentInfrastructureArgs
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    AgentInputs []SchematicsAgentAgentInputArgs
    Additional input variables for the agent.
    AgentKpis []SchematicsAgentAgentKpiArgs
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    AgentLocation string
    The location where agent is deployed in the user environment.
    AgentMetadatas []SchematicsAgentAgentMetadataArgs
    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
    Agent description.
    Name string
    The name of the agent (must be unique, for an account).
    RecentDeployJobs []SchematicsAgentRecentDeployJobArgs
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    RecentHealthJobs []SchematicsAgentRecentHealthJobArgs
    (List) Agent health check. Nested scheme for recent_health_job:
    RecentPrsJobs []SchematicsAgentRecentPrsJobArgs
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    ResourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    RunDestroyResources float64
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    SchematicsAgentId string
    The unique identifier of the schematics_agent.
    SchematicsLocation 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 []SchematicsAgentSystemStateArgs
    (List) Computed state of the agent. Nested scheme for system_state:
    Tags []string
    Tags for the agent.
    Timeouts SchematicsAgentTimeoutsArgs
    UpdatedAt string
    (String) The agent registration updation time.
    UpdatedBy string
    (String) Email address of user who updated the agent registration.
    UserState SchematicsAgentUserStateArgs
    User defined status of the agent. Nested scheme for user_state:
    Version string
    Agent version.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs List<SchematicsAgentAgentInput>
    Additional input variables for the agent.
    agentKpis List<SchematicsAgentAgentKpi>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation String
    The location where agent is deployed in the user environment.
    agentMetadatas List<SchematicsAgentAgentMetadata>
    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
    Agent description.
    name String
    The name of the agent (must be unique, for an account).
    recentDeployJobs List<SchematicsAgentRecentDeployJob>
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs List<SchematicsAgentRecentHealthJob>
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs List<SchematicsAgentRecentPrsJob>
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resourceGroup String
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    runDestroyResources Double
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId String
    The unique identifier of the schematics_agent.
    schematicsLocation 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<SchematicsAgentSystemState>
    (List) Computed state of the agent. Nested scheme for system_state:
    tags List<String>
    Tags for the agent.
    timeouts SchematicsAgentTimeouts
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    userState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    version String
    Agent version.
    agentCrn string
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentInfrastructure SchematicsAgentAgentInfrastructure
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs SchematicsAgentAgentInput[]
    Additional input variables for the agent.
    agentKpis SchematicsAgentAgentKpi[]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation string
    The location where agent is deployed in the user environment.
    agentMetadatas SchematicsAgentAgentMetadata[]
    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
    Agent description.
    name string
    The name of the agent (must be unique, for an account).
    recentDeployJobs SchematicsAgentRecentDeployJob[]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recentHealthJobs SchematicsAgentRecentHealthJob[]
    (List) Agent health check. Nested scheme for recent_health_job:
    recentPrsJobs SchematicsAgentRecentPrsJob[]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resourceGroup string
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    runDestroyResources number
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId string
    The unique identifier of the schematics_agent.
    schematicsLocation 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 SchematicsAgentSystemState[]
    (List) Computed state of the agent. Nested scheme for system_state:
    tags string[]
    Tags for the agent.
    timeouts SchematicsAgentTimeouts
    updatedAt string
    (String) The agent registration updation time.
    updatedBy string
    (String) Email address of user who updated the agent registration.
    userState SchematicsAgentUserState
    User defined status of the agent. Nested scheme for user_state:
    version string
    Agent version.
    agent_crn str
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agent_infrastructure SchematicsAgentAgentInfrastructureArgs
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agent_inputs Sequence[SchematicsAgentAgentInputArgs]
    Additional input variables for the agent.
    agent_kpis Sequence[SchematicsAgentAgentKpiArgs]
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agent_location str
    The location where agent is deployed in the user environment.
    agent_metadatas Sequence[SchematicsAgentAgentMetadataArgs]
    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
    Agent description.
    name str
    The name of the agent (must be unique, for an account).
    recent_deploy_jobs Sequence[SchematicsAgentRecentDeployJobArgs]
    (List) Post-installations checks for Agent health. Nested scheme for recent_deploy_job:
    recent_health_jobs Sequence[SchematicsAgentRecentHealthJobArgs]
    (List) Agent health check. Nested scheme for recent_health_job:
    recent_prs_jobs Sequence[SchematicsAgentRecentPrsJobArgs]
    (List) Run a pre-requisite scanner for deploying agent. Nested scheme for recent_prs_job:
    resource_group str
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    run_destroy_resources float
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematics_agent_id str
    The unique identifier of the schematics_agent.
    schematics_location str
    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[SchematicsAgentSystemStateArgs]
    (List) Computed state of the agent. Nested scheme for system_state:
    tags Sequence[str]
    Tags for the agent.
    timeouts SchematicsAgentTimeoutsArgs
    updated_at str
    (String) The agent registration updation time.
    updated_by str
    (String) Email address of user who updated the agent registration.
    user_state SchematicsAgentUserStateArgs
    User defined status of the agent. Nested scheme for user_state:
    version str
    Agent version.
    agentCrn String
    (String) The agent crn, obtained from the Schematics agent deployment configuration.
    agentInfrastructure Property Map
    The infrastructure parameters used by the agent. Nested scheme for agent_infrastructure:
    agentInputs List<Property Map>
    Additional input variables for the agent.
    agentKpis List<Property Map>
    (List) Schematics Agent key performance indicators. Nested scheme for agent_kpi:
    agentLocation String
    The location where agent is deployed in the user environment.
    agentMetadatas List<Property Map>
    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
    Agent description.
    name 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
    The resource-group name for the agent. By default, agent will be registered in Default Resource Group.
    runDestroyResources Number
    Argument which helps to run destroy resources job. Increment the value to destroy resources associated with agent deployment.
    schematicsAgentId String
    The unique identifier of the schematics_agent.
    schematicsLocation 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>
    Tags for the agent.
    timeouts Property Map
    updatedAt String
    (String) The agent registration updation time.
    updatedBy String
    (String) Email address of user who updated the agent registration.
    userState Property Map
    User defined status of the agent. Nested scheme for user_state:
    version String
    Agent version.

    Supporting Types

    SchematicsAgentAgentInfrastructure, SchematicsAgentAgentInfrastructureArgs

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

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

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

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

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

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

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

    SchematicsAgentAgentInput, SchematicsAgentAgentInputArgs

    Link string
    The reference link to the variable value By default the expression points to $self.value.
    Metadata SchematicsAgentAgentInputMetadata
    An user editable metadata for the variables.
    Name string
    The name of the agent (must be unique, for an account).
    UseDefault bool
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    Value string

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    Link string
    The reference link to the variable value By default the expression points to $self.value.
    Metadata SchematicsAgentAgentInputMetadata
    An user editable metadata for the variables.
    Name string
    The name of the agent (must be unique, for an account).
    UseDefault bool
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    Value string

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    link String
    The reference link to the variable value By default the expression points to $self.value.
    metadata SchematicsAgentAgentInputMetadata
    An user editable metadata for the variables.
    name String
    The name of the agent (must be unique, for an account).
    useDefault Boolean
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    value String

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    link string
    The reference link to the variable value By default the expression points to $self.value.
    metadata SchematicsAgentAgentInputMetadata
    An user editable metadata for the variables.
    name string
    The name of the agent (must be unique, for an account).
    useDefault boolean
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    value string

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    link str
    The reference link to the variable value By default the expression points to $self.value.
    metadata SchematicsAgentAgentInputMetadata
    An user editable metadata for the variables.
    name str
    The name of the agent (must be unique, for an account).
    use_default bool
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    value str

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    link String
    The reference link to the variable value By default the expression points to $self.value.
    metadata Property Map
    An user editable metadata for the variables.
    name String
    The name of the agent (must be unique, for an account).
    useDefault Boolean
    True, will ignore the data in the value attribute, instead the data in metadata.default_value will be used.
    value String

    The value for the variable or reference to the value. For example, `value = "<provide your ssh_key_value with

    ". **Note** The SSH key should contain ` at the end of the key details in case of command line or API calls.

    SchematicsAgentAgentInputMetadata, SchematicsAgentAgentInputMetadataArgs

    Aliases List<string>
    The list of aliases for the variable name.
    CloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    DefaultValue string
    Default value for the variable only if the override value is not specified.
    Description string
    Agent description.
    GroupBy string
    The display name of the group this variable belongs to.
    Hidden bool
    If true, the variable is not displayed on UI or Command line.
    Immutable bool
    Is the variable readonly ?.
    LinkStatus string
    The status of the link.
    Matches string
    The regex for the variable value.
    MaxLength double
    The maximum length of the variable value. Applicable for the string type.
    MaxValue double
    The maximum value of the variable. Applicable for the integer type.
    MinLength double
    The minimum length of the variable value. Applicable for the string type.
    MinValue double
    The minimum value of the variable. Applicable for the integer type.
    Options List<string>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    Position double
    The relative position of this variable in a list.
    Required bool
    If the variable required?.
    Secure bool
    Is the variable secure or sensitive ?.
    Source string
    The source of this meta-data.
    Type string
    Type of the variable.
    Aliases []string
    The list of aliases for the variable name.
    CloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    DefaultValue string
    Default value for the variable only if the override value is not specified.
    Description string
    Agent description.
    GroupBy string
    The display name of the group this variable belongs to.
    Hidden bool
    If true, the variable is not displayed on UI or Command line.
    Immutable bool
    Is the variable readonly ?.
    LinkStatus string
    The status of the link.
    Matches string
    The regex for the variable value.
    MaxLength float64
    The maximum length of the variable value. Applicable for the string type.
    MaxValue float64
    The maximum value of the variable. Applicable for the integer type.
    MinLength float64
    The minimum length of the variable value. Applicable for the string type.
    MinValue float64
    The minimum value of the variable. Applicable for the integer type.
    Options []string
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    Position float64
    The relative position of this variable in a list.
    Required bool
    If the variable required?.
    Secure bool
    Is the variable secure or sensitive ?.
    Source string
    The source of this meta-data.
    Type string
    Type of the variable.
    aliases List<String>
    The list of aliases for the variable name.
    cloudDataType String
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    defaultValue String
    Default value for the variable only if the override value is not specified.
    description String
    Agent description.
    groupBy String
    The display name of the group this variable belongs to.
    hidden Boolean
    If true, the variable is not displayed on UI or Command line.
    immutable Boolean
    Is the variable readonly ?.
    linkStatus String
    The status of the link.
    matches String
    The regex for the variable value.
    maxLength Double
    The maximum length of the variable value. Applicable for the string type.
    maxValue Double
    The maximum value of the variable. Applicable for the integer type.
    minLength Double
    The minimum length of the variable value. Applicable for the string type.
    minValue Double
    The minimum value of the variable. Applicable for the integer type.
    options List<String>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position Double
    The relative position of this variable in a list.
    required Boolean
    If the variable required?.
    secure Boolean
    Is the variable secure or sensitive ?.
    source String
    The source of this meta-data.
    type String
    Type of the variable.
    aliases string[]
    The list of aliases for the variable name.
    cloudDataType string
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    defaultValue string
    Default value for the variable only if the override value is not specified.
    description string
    Agent description.
    groupBy string
    The display name of the group this variable belongs to.
    hidden boolean
    If true, the variable is not displayed on UI or Command line.
    immutable boolean
    Is the variable readonly ?.
    linkStatus string
    The status of the link.
    matches string
    The regex for the variable value.
    maxLength number
    The maximum length of the variable value. Applicable for the string type.
    maxValue number
    The maximum value of the variable. Applicable for the integer type.
    minLength number
    The minimum length of the variable value. Applicable for the string type.
    minValue number
    The minimum value of the variable. Applicable for the integer type.
    options string[]
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position number
    The relative position of this variable in a list.
    required boolean
    If the variable required?.
    secure boolean
    Is the variable secure or sensitive ?.
    source string
    The source of this meta-data.
    type string
    Type of the variable.
    aliases Sequence[str]
    The list of aliases for the variable name.
    cloud_data_type str
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    default_value str
    Default value for the variable only if the override value is not specified.
    description str
    Agent description.
    group_by str
    The display name of the group this variable belongs to.
    hidden bool
    If true, the variable is not displayed on UI or Command line.
    immutable bool
    Is the variable readonly ?.
    link_status str
    The status of the link.
    matches str
    The regex for the variable value.
    max_length float
    The maximum length of the variable value. Applicable for the string type.
    max_value float
    The maximum value of the variable. Applicable for the integer type.
    min_length float
    The minimum length of the variable value. Applicable for the string type.
    min_value float
    The minimum value of the variable. Applicable for the integer type.
    options Sequence[str]
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position float
    The relative position of this variable in a list.
    required bool
    If the variable required?.
    secure bool
    Is the variable secure or sensitive ?.
    source str
    The source of this meta-data.
    type str
    Type of the variable.
    aliases List<String>
    The list of aliases for the variable name.
    cloudDataType String
    Cloud data type of the variable. eg. resource_group_id, region, vpc_id.
    defaultValue String
    Default value for the variable only if the override value is not specified.
    description String
    Agent description.
    groupBy String
    The display name of the group this variable belongs to.
    hidden Boolean
    If true, the variable is not displayed on UI or Command line.
    immutable Boolean
    Is the variable readonly ?.
    linkStatus String
    The status of the link.
    matches String
    The regex for the variable value.
    maxLength Number
    The maximum length of the variable value. Applicable for the string type.
    maxValue Number
    The maximum value of the variable. Applicable for the integer type.
    minLength Number
    The minimum length of the variable value. Applicable for the string type.
    minValue Number
    The minimum value of the variable. Applicable for the integer type.
    options List<String>
    The list of possible values for this variable. If type is integer or date, then the array of string is converted to array of integers or date during the runtime.
    position Number
    The relative position of this variable in a list.
    required Boolean
    If the variable required?.
    secure Boolean
    Is the variable secure or sensitive ?.
    source String
    The source of this meta-data.
    type String
    Type of the variable.

    SchematicsAgentAgentKpi, SchematicsAgentAgentKpiArgs

    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.

    SchematicsAgentAgentMetadata, SchematicsAgentAgentMetadataArgs

    Name string
    Name of the metadata.
    Values List<string>
    Value of the metadata name.
    Name string
    Name of the metadata.
    Values []string
    Value of the metadata name.
    name String
    Name of the metadata.
    values List<String>
    Value of the metadata name.
    name string
    Name of the metadata.
    values string[]
    Value of the metadata name.
    name str
    Name of the metadata.
    values Sequence[str]
    Value of the metadata name.
    name String
    Name of the metadata.
    values List<String>
    Value of the metadata name.

    SchematicsAgentRecentDeployJob, SchematicsAgentRecentDeployJobArgs

    AgentId string
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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.

    SchematicsAgentRecentHealthJob, SchematicsAgentRecentHealthJobArgs

    AgentId string
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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.

    SchematicsAgentRecentPrsJob, SchematicsAgentRecentPrsJobArgs

    AgentId string
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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
    (String) Id of the 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.

    SchematicsAgentSystemState, SchematicsAgentSystemStateArgs

    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.

    SchematicsAgentTimeouts, SchematicsAgentTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    SchematicsAgentUserState, SchematicsAgentUserStateArgs

    SetAt string
    When the User who set the state of the Object.
    SetBy string
    Name of the User who set the state of the Object.
    State 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
    When the User who set the state of the Object.
    SetBy string
    Name of the User who set the state of the Object.
    State 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
    When the User who set the state of the Object.
    setBy String
    Name of the User who set the state of the Object.
    state 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
    When the User who set the state of the Object.
    setBy string
    Name of the User who set the state of the Object.
    state 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
    When the User who set the state of the Object.
    set_by str
    Name of the User who set the state of the Object.
    state str
    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
    When the User who set the state of the Object.
    setBy String
    Name of the User who set the state of the Object.
    state String
    User-defined states * enable Agent is enabled by the user. * disable Agent is disbaled by the user.

    • Constraints: Allowable values are: enable, disable.

    Import

    You can import the ibm_schematics_agent resource by using id. The agent resource id.

    Syntax

    $ pulumi import ibm:index/schematicsAgent:SchematicsAgent schematics_agent <id>

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

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm