ibm 1.77.1, Apr 14 25

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getSchematicsAction

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const schematicsAction = ibm.getSchematicsAction({
    actionId: "action_id",
});

import pulumi
import pulumi_ibm as ibm

schematics_action = ibm.get_schematics_action(action_id="action_id")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupSchematicsAction(ctx, &ibm.LookupSchematicsActionArgs{
			ActionId: "action_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var schematicsAction = Ibm.GetSchematicsAction.Invoke(new()
    {
        ActionId = "action_id",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSchematicsActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var schematicsAction = IbmFunctions.getSchematicsAction(GetSchematicsActionArgs.builder()
            .actionId("action_id")
            .build());

    }
}

variables:
  schematicsAction:
    fn::invoke:
      function: ibm:getSchematicsAction
      arguments:
        actionId: action_id

Using getSchematicsAction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getSchematicsAction(args: GetSchematicsActionArgs, opts?: InvokeOptions): Promise<GetSchematicsActionResult>
function getSchematicsActionOutput(args: GetSchematicsActionOutputArgs, opts?: InvokeOptions): Output<GetSchematicsActionResult>

def get_schematics_action(action_id: Optional[str] = None,
                          location: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSchematicsActionResult
def get_schematics_action_output(action_id: Optional[pulumi.Input[str]] = None,
                          location: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSchematicsActionResult]

func LookupSchematicsAction(ctx *Context, args *LookupSchematicsActionArgs, opts ...InvokeOption) (*LookupSchematicsActionResult, error)
func LookupSchematicsActionOutput(ctx *Context, args *LookupSchematicsActionOutputArgs, opts ...InvokeOption) LookupSchematicsActionResultOutput

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

public static class GetSchematicsAction 
{
    public static Task<GetSchematicsActionResult> InvokeAsync(GetSchematicsActionArgs args, InvokeOptions? opts = null)
    public static Output<GetSchematicsActionResult> Invoke(GetSchematicsActionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchematicsActionResult> getSchematicsAction(GetSchematicsActionArgs args, InvokeOptions options)
public static Output<GetSchematicsActionResult> getSchematicsAction(GetSchematicsActionArgs args, InvokeOptions options)

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

The following arguments are supported:

ActionId string

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

Location string

Location 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

ActionId string

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

Location string

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

actionId String

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

location String

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

actionId string

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

location string

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

action_id str

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

location str

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

actionId String

Action Id. Use GET /actions API to look up the Action Ids in your IBM Cloud account.

location String

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de

getSchematicsAction Result

The following output properties are available:

Account string

ActionId string

ActionInputs List<GetSchematicsActionActionInput>

(List) Input variables for the Action. Nested scheme for action_inputs:

ActionOutputs List<GetSchematicsActionActionOutput>

(List) Output variables for the Action. Nested scheme for action_outputs:

BastionCredentials List<GetSchematicsActionBastionCredential>

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

Bastions List<GetSchematicsActionBastion>

(List) Describes a bastion resource. Nested scheme for bastion:

CommandParameter string

(String) Schematics job command parameter (playbook-name).

CreatedAt string

(String) Action creation time.

CreatedBy string

(String) E-mail address of the user who created an action.

Credentials List<GetSchematicsActionCredential>

(List) credentials of the Action. Nested scheme for credentials:

Crn string

(String) Action Cloud Resource Name.

Description string

(String) Description of the meta data.

Id string

(String) Action ID.

Inventory string

(String) Target inventory record ID, used by the action or ansible playbook.

Location string

Name string

(String) Name of the variable.

PlaybookNames List<string>

(List) Playbook names retrieved from the respository.

ResourceGroup string

(String) Resource-group name for an action. By default, action is created in default resource group.

Settings List<GetSchematicsActionSetting>

(List) Environment variables for the Action. Nested scheme for settings:

SourceCreatedAt string

(String) Action Playbook Source creation time.

SourceCreatedBy string

(String) E-mail address of user who created the Action Playbook Source.

SourceReadmeUrl string

(String) URL of the README file, for the source URL.

SourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

SourceUpdatedAt string

(String) The action playbook updation time.

SourceUpdatedBy string

(String) E-mail address of user who updated the action playbook source.

Sources List<GetSchematicsActionSource>

(List) Source of templates, playbooks, or controls. Nested scheme for source:

States List<GetSchematicsActionState>

(String) User-defined states * draft Object can be modified; can be used by Jobs run by the author, during execution * live Object can be modified; can be used by Jobs during execution * locked Object cannot be modified; can be used by Jobs during execution * disable Object can be modified. cannot be used by Jobs during execution.

Constraints: Allowable values are: draft, live, locked, disable

SysLocks List<GetSchematicsActionSysLock>

(List) System lock status. Nested scheme for sys_lock:

Tags List<string>

(List) Action tags.

TargetsIni string

(String) Inventory of host and host group for the playbook in INI file format. For example, "targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5". For more information, about an inventory host group syntax, see Inventory host groups.

UpdatedAt string

(String) Action updation time.

UpdatedBy string

(String) E-mail address of the user who updated an action.

UserStates List<GetSchematicsActionUserState>

(List) User defined status of the Schematics object. Nested scheme for user_state:

Account string

ActionId string

ActionInputs []GetSchematicsActionActionInput

(List) Input variables for the Action. Nested scheme for action_inputs:

ActionOutputs []GetSchematicsActionActionOutput

(List) Output variables for the Action. Nested scheme for action_outputs:

BastionCredentials []GetSchematicsActionBastionCredential

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

Bastions []GetSchematicsActionBastion

(List) Describes a bastion resource. Nested scheme for bastion:

CommandParameter string

(String) Schematics job command parameter (playbook-name).

CreatedAt string

(String) Action creation time.

CreatedBy string

(String) E-mail address of the user who created an action.

Credentials []GetSchematicsActionCredential

(List) credentials of the Action. Nested scheme for credentials:

Crn string

(String) Action Cloud Resource Name.

Description string

(String) Description of the meta data.

Id string

(String) Action ID.

Inventory string

(String) Target inventory record ID, used by the action or ansible playbook.

Location string

Name string

(String) Name of the variable.

PlaybookNames []string

(List) Playbook names retrieved from the respository.

ResourceGroup string

(String) Resource-group name for an action. By default, action is created in default resource group.

Settings []GetSchematicsActionSetting

(List) Environment variables for the Action. Nested scheme for settings:

SourceCreatedAt string

(String) Action Playbook Source creation time.

SourceCreatedBy string

(String) E-mail address of user who created the Action Playbook Source.

SourceReadmeUrl string

(String) URL of the README file, for the source URL.

SourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

SourceUpdatedAt string

(String) The action playbook updation time.

SourceUpdatedBy string

(String) E-mail address of user who updated the action playbook source.

Sources []GetSchematicsActionSource

(List) Source of templates, playbooks, or controls. Nested scheme for source:

States []GetSchematicsActionState

Constraints: Allowable values are: draft, live, locked, disable

SysLocks []GetSchematicsActionSysLock

(List) System lock status. Nested scheme for sys_lock:

Tags []string

(List) Action tags.

TargetsIni string

UpdatedAt string

(String) Action updation time.

UpdatedBy string

(String) E-mail address of the user who updated an action.

UserStates []GetSchematicsActionUserState

(List) User defined status of the Schematics object. Nested scheme for user_state:

account String

actionId String

actionInputs List<GetSchematicsActionActionInput>

(List) Input variables for the Action. Nested scheme for action_inputs:

actionOutputs List<GetSchematicsActionActionOutput>

(List) Output variables for the Action. Nested scheme for action_outputs:

bastionCredentials List<GetSchematicsActionBastionCredential>

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

bastions List<GetSchematicsActionBastion>

(List) Describes a bastion resource. Nested scheme for bastion:

commandParameter String

(String) Schematics job command parameter (playbook-name).

createdAt String

(String) Action creation time.

createdBy String

(String) E-mail address of the user who created an action.

credentials List<GetSchematicsActionCredential>

(List) credentials of the Action. Nested scheme for credentials:

crn String

(String) Action Cloud Resource Name.

description String

(String) Description of the meta data.

id String

(String) Action ID.

inventory String

(String) Target inventory record ID, used by the action or ansible playbook.

location String

name String

(String) Name of the variable.

playbookNames List<String>

(List) Playbook names retrieved from the respository.

resourceGroup String

(String) Resource-group name for an action. By default, action is created in default resource group.

settings List<GetSchematicsActionSetting>

(List) Environment variables for the Action. Nested scheme for settings:

sourceCreatedAt String

(String) Action Playbook Source creation time.

sourceCreatedBy String

(String) E-mail address of user who created the Action Playbook Source.

sourceReadmeUrl String

(String) URL of the README file, for the source URL.

sourceType String

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

sourceUpdatedAt String

(String) The action playbook updation time.

sourceUpdatedBy String

(String) E-mail address of user who updated the action playbook source.

sources List<GetSchematicsActionSource>

(List) Source of templates, playbooks, or controls. Nested scheme for source:

states List<GetSchematicsActionState>

Constraints: Allowable values are: draft, live, locked, disable

sysLocks List<GetSchematicsActionSysLock>

(List) System lock status. Nested scheme for sys_lock:

tags List<String>

(List) Action tags.

targetsIni String

updatedAt String

(String) Action updation time.

updatedBy String

(String) E-mail address of the user who updated an action.

userStates List<GetSchematicsActionUserState>

(List) User defined status of the Schematics object. Nested scheme for user_state:

account string

actionId string

actionInputs GetSchematicsActionActionInput[]

(List) Input variables for the Action. Nested scheme for action_inputs:

actionOutputs GetSchematicsActionActionOutput[]

(List) Output variables for the Action. Nested scheme for action_outputs:

bastionCredentials GetSchematicsActionBastionCredential[]

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

bastions GetSchematicsActionBastion[]

(List) Describes a bastion resource. Nested scheme for bastion:

commandParameter string

(String) Schematics job command parameter (playbook-name).

createdAt string

(String) Action creation time.

createdBy string

(String) E-mail address of the user who created an action.

credentials GetSchematicsActionCredential[]

(List) credentials of the Action. Nested scheme for credentials:

crn string

(String) Action Cloud Resource Name.

description string

(String) Description of the meta data.

id string

(String) Action ID.

inventory string

(String) Target inventory record ID, used by the action or ansible playbook.

location string

name string

(String) Name of the variable.

playbookNames string[]

(List) Playbook names retrieved from the respository.

resourceGroup string

(String) Resource-group name for an action. By default, action is created in default resource group.

settings GetSchematicsActionSetting[]

(List) Environment variables for the Action. Nested scheme for settings:

sourceCreatedAt string

(String) Action Playbook Source creation time.

sourceCreatedBy string

(String) E-mail address of user who created the Action Playbook Source.

sourceReadmeUrl string

(String) URL of the README file, for the source URL.

sourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

sourceUpdatedAt string

(String) The action playbook updation time.

sourceUpdatedBy string

(String) E-mail address of user who updated the action playbook source.

sources GetSchematicsActionSource[]

(List) Source of templates, playbooks, or controls. Nested scheme for source:

states GetSchematicsActionState[]

Constraints: Allowable values are: draft, live, locked, disable

sysLocks GetSchematicsActionSysLock[]

(List) System lock status. Nested scheme for sys_lock:

tags string[]

(List) Action tags.

targetsIni string

updatedAt string

(String) Action updation time.

updatedBy string

(String) E-mail address of the user who updated an action.

userStates GetSchematicsActionUserState[]

(List) User defined status of the Schematics object. Nested scheme for user_state:

account str

action_id str

action_inputs Sequence[GetSchematicsActionActionInput]

(List) Input variables for the Action. Nested scheme for action_inputs:

action_outputs Sequence[GetSchematicsActionActionOutput]

(List) Output variables for the Action. Nested scheme for action_outputs:

bastion_credentials Sequence[GetSchematicsActionBastionCredential]

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

bastions Sequence[GetSchematicsActionBastion]

(List) Describes a bastion resource. Nested scheme for bastion:

command_parameter str

(String) Schematics job command parameter (playbook-name).

created_at str

(String) Action creation time.

created_by str

(String) E-mail address of the user who created an action.

credentials Sequence[GetSchematicsActionCredential]

(List) credentials of the Action. Nested scheme for credentials:

crn str

(String) Action Cloud Resource Name.

description str

(String) Description of the meta data.

id str

(String) Action ID.

inventory str

(String) Target inventory record ID, used by the action or ansible playbook.

location str

name str

(String) Name of the variable.

playbook_names Sequence[str]

(List) Playbook names retrieved from the respository.

resource_group str

(String) Resource-group name for an action. By default, action is created in default resource group.

settings Sequence[GetSchematicsActionSetting]

(List) Environment variables for the Action. Nested scheme for settings:

source_created_at str

(String) Action Playbook Source creation time.

source_created_by str

(String) E-mail address of user who created the Action Playbook Source.

source_readme_url str

(String) URL of the README file, for the source URL.

source_type str

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

source_updated_at str

(String) The action playbook updation time.

source_updated_by str

(String) E-mail address of user who updated the action playbook source.

sources Sequence[GetSchematicsActionSource]

(List) Source of templates, playbooks, or controls. Nested scheme for source:

states Sequence[GetSchematicsActionState]

Constraints: Allowable values are: draft, live, locked, disable

sys_locks Sequence[GetSchematicsActionSysLock]

(List) System lock status. Nested scheme for sys_lock:

tags Sequence[str]

(List) Action tags.

targets_ini str

updated_at str

(String) Action updation time.

updated_by str

(String) E-mail address of the user who updated an action.

user_states Sequence[GetSchematicsActionUserState]

(List) User defined status of the Schematics object. Nested scheme for user_state:

account String

actionId String

actionInputs List<Property Map>

(List) Input variables for the Action. Nested scheme for action_inputs:

actionOutputs List<Property Map>

(List) Output variables for the Action. Nested scheme for action_outputs:

bastionCredentials List<Property Map>

(List) User editable variable data & system generated reference to value. Nested scheme for bastion_credential:

bastions List<Property Map>

(List) Describes a bastion resource. Nested scheme for bastion:

commandParameter String

(String) Schematics job command parameter (playbook-name).

createdAt String

(String) Action creation time.

createdBy String

(String) E-mail address of the user who created an action.

credentials List<Property Map>

(List) credentials of the Action. Nested scheme for credentials:

crn String

(String) Action Cloud Resource Name.

description String

(String) Description of the meta data.

id String

(String) Action ID.

inventory String

(String) Target inventory record ID, used by the action or ansible playbook.

location String

name String

(String) Name of the variable.

playbookNames List<String>

(List) Playbook names retrieved from the respository.

resourceGroup String

(String) Resource-group name for an action. By default, action is created in default resource group.

settings List<Property Map>

(List) Environment variables for the Action. Nested scheme for settings:

sourceCreatedAt String

(String) Action Playbook Source creation time.

sourceCreatedBy String

(String) E-mail address of user who created the Action Playbook Source.

sourceReadmeUrl String

(String) URL of the README file, for the source URL.

sourceType String

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

sourceUpdatedAt String

(String) The action playbook updation time.

sourceUpdatedBy String

(String) E-mail address of user who updated the action playbook source.

sources List<Property Map>

(List) Source of templates, playbooks, or controls. Nested scheme for source:

states List<Property Map>

Constraints: Allowable values are: draft, live, locked, disable

sysLocks List<Property Map>

(List) System lock status. Nested scheme for sys_lock:

tags List<String>

(List) Action tags.

targetsIni String

updatedAt String

(String) Action updation time.

updatedBy String

(String) E-mail address of the user who updated an action.

userStates List<Property Map>

(List) User defined status of the Schematics object. Nested scheme for user_state:

Supporting Types

GetSchematicsActionActionInput

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas List<GetSchematicsActionActionInputMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas []GetSchematicsActionActionInputMetadata: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<GetSchematicsActionActionInputMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

link string: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas GetSchematicsActionActionInputMetadata[]: (List) User editable metadata for the variables. Nested scheme for metadata:
name string: (String) Name of the variable.
value string: (String) Value for the variable or reference to the value.

link str: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[GetSchematicsActionActionInputMetadata]: (List) User editable metadata for the variables. Nested scheme for metadata:
name str: (String) Name of the variable.
value str: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

GetSchematicsActionActionInputMetadata

Aliases List<string>

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength double

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue double

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength double

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue double

(Integer) Minimum value of the variable. Applicable for integer type.

Options List<string>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position double

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

Aliases []string

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength float64

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue float64

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength float64

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue float64

(Integer) Minimum value of the variable. Applicable for integer type.

Options []string

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position float64

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Double

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Double

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Double

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Double

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Double

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases string[]

(List) List of aliases for the variable name.

defaultValue string

(String) Default value for the variable, if the override value is not specified.

description string

(String) Description of the meta data.

groupBy string

(String) Display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable boolean

(Boolean) Is the variable readonly ?.

matches string

(String) Regex for the variable value.

maxLength number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue number

(Integer) Minimum value of the variable. Applicable for integer type.

options string[]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position number

(Integer) Relative position of this variable in a list.

secure boolean

(Boolean) Is the variable secure or sensitive ?.

source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases Sequence[str]

(List) List of aliases for the variable name.

default_value str

(String) Default value for the variable, if the override value is not specified.

description str

(String) Description of the meta data.

group_by str

(String) Display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable bool

(Boolean) Is the variable readonly ?.

matches str

(String) Regex for the variable value.

max_length float

(Integer) Maximum length of the variable value. Applicable for string type.

max_value float

(Integer) Maximum value of the variable. Applicable for integer type.

min_length float

(Integer) Minimum length of the variable value. Applicable for string type.

min_value float

(Integer) Minimum value of the variable. Applicable for integer type.

options Sequence[str]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position float

(Integer) Relative position of this variable in a list.

secure bool

(Boolean) Is the variable secure or sensitive ?.

source str

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type str

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Number

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Number

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

GetSchematicsActionActionOutput

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas List<GetSchematicsActionActionOutputMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas []GetSchematicsActionActionOutputMetadata: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<GetSchematicsActionActionOutputMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

link string: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas GetSchematicsActionActionOutputMetadata[]: (List) User editable metadata for the variables. Nested scheme for metadata:
name string: (String) Name of the variable.
value string: (String) Value for the variable or reference to the value.

link str: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[GetSchematicsActionActionOutputMetadata]: (List) User editable metadata for the variables. Nested scheme for metadata:
name str: (String) Name of the variable.
value str: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

GetSchematicsActionActionOutputMetadata

Aliases List<string>

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength double

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue double

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength double

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue double

(Integer) Minimum value of the variable. Applicable for integer type.

Options List<string>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position double

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

Aliases []string

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength float64

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue float64

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength float64

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue float64

(Integer) Minimum value of the variable. Applicable for integer type.

Options []string

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position float64

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Double

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Double

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Double

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Double

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Double

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases string[]

(List) List of aliases for the variable name.

defaultValue string

(String) Default value for the variable, if the override value is not specified.

description string

(String) Description of the meta data.

groupBy string

(String) Display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable boolean

(Boolean) Is the variable readonly ?.

matches string

(String) Regex for the variable value.

maxLength number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue number

(Integer) Minimum value of the variable. Applicable for integer type.

options string[]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position number

(Integer) Relative position of this variable in a list.

secure boolean

(Boolean) Is the variable secure or sensitive ?.

source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases Sequence[str]

(List) List of aliases for the variable name.

default_value str

(String) Default value for the variable, if the override value is not specified.

description str

(String) Description of the meta data.

group_by str

(String) Display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable bool

(Boolean) Is the variable readonly ?.

matches str

(String) Regex for the variable value.

max_length float

(Integer) Maximum length of the variable value. Applicable for string type.

max_value float

(Integer) Maximum value of the variable. Applicable for integer type.

min_length float

(Integer) Minimum length of the variable value. Applicable for string type.

min_value float

(Integer) Minimum value of the variable. Applicable for integer type.

options Sequence[str]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position float

(Integer) Relative position of this variable in a list.

secure bool

(Boolean) Is the variable secure or sensitive ?.

source str

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type str

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Number

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Number

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

GetSchematicsActionBastion

Host string: (String) Reference to the Inventory resource definition.
Name string: (String) Name of the variable.

Host string: (String) Reference to the Inventory resource definition.
Name string: (String) Name of the variable.

host String: (String) Reference to the Inventory resource definition.
name String: (String) Name of the variable.

host string: (String) Reference to the Inventory resource definition.
name string: (String) Name of the variable.

host str: (String) Reference to the Inventory resource definition.
name str: (String) Name of the variable.

host String: (String) Reference to the Inventory resource definition.
name String: (String) Name of the variable.

GetSchematicsActionBastionCredential

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas List<GetSchematicsActionBastionCredentialMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas []GetSchematicsActionBastionCredentialMetadata: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<GetSchematicsActionBastionCredentialMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

link string: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas GetSchematicsActionBastionCredentialMetadata[]: (List) User editable metadata for the variables. Nested scheme for metadata:
name string: (String) Name of the variable.
value string: (String) Value for the variable or reference to the value.

link str: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[GetSchematicsActionBastionCredentialMetadata]: (List) User editable metadata for the variables. Nested scheme for metadata:
name str: (String) Name of the variable.
value str: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

GetSchematicsActionBastionCredentialMetadata

Aliases List<string>

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength double

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue double

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength double

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue double

(Integer) Minimum value of the variable. Applicable for integer type.

Options List<string>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position double

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

Aliases []string

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength float64

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue float64

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength float64

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue float64

(Integer) Minimum value of the variable. Applicable for integer type.

Options []string

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position float64

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Double

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Double

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Double

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Double

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Double

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases string[]

(List) List of aliases for the variable name.

defaultValue string

(String) Default value for the variable, if the override value is not specified.

description string

(String) Description of the meta data.

groupBy string

(String) Display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable boolean

(Boolean) Is the variable readonly ?.

matches string

(String) Regex for the variable value.

maxLength number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue number

(Integer) Minimum value of the variable. Applicable for integer type.

options string[]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position number

(Integer) Relative position of this variable in a list.

secure boolean

(Boolean) Is the variable secure or sensitive ?.

source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases Sequence[str]

(List) List of aliases for the variable name.

default_value str

(String) Default value for the variable, if the override value is not specified.

description str

(String) Description of the meta data.

group_by str

(String) Display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable bool

(Boolean) Is the variable readonly ?.

matches str

(String) Regex for the variable value.

max_length float

(Integer) Maximum length of the variable value. Applicable for string type.

max_value float

(Integer) Maximum value of the variable. Applicable for integer type.

min_length float

(Integer) Minimum length of the variable value. Applicable for string type.

min_value float

(Integer) Minimum value of the variable. Applicable for integer type.

options Sequence[str]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position float

(Integer) Relative position of this variable in a list.

secure bool

(Boolean) Is the variable secure or sensitive ?.

source str

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type str

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Number

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Number

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

GetSchematicsActionCredential

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas List<GetSchematicsActionCredentialMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas []GetSchematicsActionCredentialMetadata: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<GetSchematicsActionCredentialMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

link string: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas GetSchematicsActionCredentialMetadata[]: (List) User editable metadata for the variables. Nested scheme for metadata:
name string: (String) Name of the variable.
value string: (String) Value for the variable or reference to the value.

link str: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[GetSchematicsActionCredentialMetadata]: (List) User editable metadata for the variables. Nested scheme for metadata:
name str: (String) Name of the variable.
value str: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

GetSchematicsActionCredentialMetadata

Aliases List<string>

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Position double

(Integer) Relative position of this variable in a list.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

Aliases []string

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Position float64

(Integer) Relative position of this variable in a list.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

position Double

(Integer) Relative position of this variable in a list.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases string[]

(List) List of aliases for the variable name.

defaultValue string

(String) Default value for the variable, if the override value is not specified.

description string

(String) Description of the meta data.

groupBy string

(String) Display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable boolean

(Boolean) Is the variable readonly ?.

position number

(Integer) Relative position of this variable in a list.

source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases Sequence[str]

(List) List of aliases for the variable name.

default_value str

(String) Default value for the variable, if the override value is not specified.

description str

(String) Description of the meta data.

group_by str

(String) Display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable bool

(Boolean) Is the variable readonly ?.

position float

(Integer) Relative position of this variable in a list.

source str

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type str

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

position Number

(Integer) Relative position of this variable in a list.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

GetSchematicsActionSetting

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas List<GetSchematicsActionSettingMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

Link string: (String) Reference link to the variable value By default the expression will point to self.value.
Metadatas []GetSchematicsActionSettingMetadata: (List) User editable metadata for the variables. Nested scheme for metadata:
Name string: (String) Name of the variable.
Value string: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<GetSchematicsActionSettingMetadata>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

link string: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas GetSchematicsActionSettingMetadata[]: (List) User editable metadata for the variables. Nested scheme for metadata:
name string: (String) Name of the variable.
value string: (String) Value for the variable or reference to the value.

link str: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas Sequence[GetSchematicsActionSettingMetadata]: (List) User editable metadata for the variables. Nested scheme for metadata:
name str: (String) Name of the variable.
value str: (String) Value for the variable or reference to the value.

link String: (String) Reference link to the variable value By default the expression will point to self.value.
metadatas List<Property Map>: (List) User editable metadata for the variables. Nested scheme for metadata:
name String: (String) Name of the variable.
value String: (String) Value for the variable or reference to the value.

GetSchematicsActionSettingMetadata

Aliases List<string>

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength double

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue double

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength double

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue double

(Integer) Minimum value of the variable. Applicable for integer type.

Options List<string>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position double

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

Aliases []string

(List) List of aliases for the variable name.

DefaultValue string

(String) Default value for the variable, if the override value is not specified.

Description string

(String) Description of the meta data.

GroupBy string

(String) Display name of the group this variable belongs to.

Hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

Immutable bool

(Boolean) Is the variable readonly ?.

Matches string

(String) Regex for the variable value.

MaxLength float64

(Integer) Maximum length of the variable value. Applicable for string type.

MaxValue float64

(Integer) Maximum value of the variable. Applicable for integer type.

MinLength float64

(Integer) Minimum length of the variable value. Applicable for string type.

MinValue float64

(Integer) Minimum value of the variable. Applicable for integer type.

Options []string

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

Position float64

(Integer) Relative position of this variable in a list.

Secure bool

(Boolean) Is the variable secure or sensitive ?.

Source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

Type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Double

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Double

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Double

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Double

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Double

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases string[]

(List) List of aliases for the variable name.

defaultValue string

(String) Default value for the variable, if the override value is not specified.

description string

(String) Description of the meta data.

groupBy string

(String) Display name of the group this variable belongs to.

hidden boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable boolean

(Boolean) Is the variable readonly ?.

matches string

(String) Regex for the variable value.

maxLength number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue number

(Integer) Minimum value of the variable. Applicable for integer type.

options string[]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position number

(Integer) Relative position of this variable in a list.

secure boolean

(Boolean) Is the variable secure or sensitive ?.

source string

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type string

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases Sequence[str]

(List) List of aliases for the variable name.

default_value str

(String) Default value for the variable, if the override value is not specified.

description str

(String) Description of the meta data.

group_by str

(String) Display name of the group this variable belongs to.

hidden bool

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable bool

(Boolean) Is the variable readonly ?.

matches str

(String) Regex for the variable value.

max_length float

(Integer) Maximum length of the variable value. Applicable for string type.

max_value float

(Integer) Maximum value of the variable. Applicable for integer type.

min_length float

(Integer) Minimum length of the variable value. Applicable for string type.

min_value float

(Integer) Minimum value of the variable. Applicable for integer type.

options Sequence[str]

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position float

(Integer) Relative position of this variable in a list.

secure bool

(Boolean) Is the variable secure or sensitive ?.

source str

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type str

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

aliases List<String>

(List) List of aliases for the variable name.

defaultValue String

(String) Default value for the variable, if the override value is not specified.

description String

(String) Description of the meta data.

groupBy String

(String) Display name of the group this variable belongs to.

hidden Boolean

(Boolean) If true, the variable will not be displayed on UI or CLI.

immutable Boolean

(Boolean) Is the variable readonly ?.

matches String

(String) Regex for the variable value.

maxLength Number

(Integer) Maximum length of the variable value. Applicable for string type.

maxValue Number

(Integer) Maximum value of the variable. Applicable for integer type.

minLength Number

(Integer) Minimum length of the variable value. Applicable for string type.

minValue Number

(Integer) Minimum value of the variable. Applicable for integer type.

options List<String>

(List) List of possible values for this variable. If type is integer or date, then the array of string will be converted to array of integers or date during runtime.

position Number

(Integer) Relative position of this variable in a list.

secure Boolean

(Boolean) Is the variable secure or sensitive ?.

source String

(List) Source of templates, playbooks, or controls. Nested scheme for source:

type String

(String) Type of the variable.

Constraints: Allowable values are: boolean, string, integer, date, array, list, map, complex

GetSchematicsActionSource

Catalogs List<GetSchematicsActionSourceCatalog>

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

Gits List<GetSchematicsActionSourceGit>

(List) Connection details to Git source. Nested scheme for git:

SourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

Catalogs []GetSchematicsActionSourceCatalog

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

Gits []GetSchematicsActionSourceGit

(List) Connection details to Git source. Nested scheme for git:

SourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

catalogs List<GetSchematicsActionSourceCatalog>

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

gits List<GetSchematicsActionSourceGit>

(List) Connection details to Git source. Nested scheme for git:

sourceType String

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

catalogs GetSchematicsActionSourceCatalog[]

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

gits GetSchematicsActionSourceGit[]

(List) Connection details to Git source. Nested scheme for git:

sourceType string

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

catalogs Sequence[GetSchematicsActionSourceCatalog]

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

gits Sequence[GetSchematicsActionSourceGit]

(List) Connection details to Git source. Nested scheme for git:

source_type str

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

catalogs List<Property Map>

(List) Connection details to IBM Cloud Catalog source. Nested scheme for catalog:

gits List<Property Map>

(List) Connection details to Git source. Nested scheme for git:

sourceType String

(String) Type of source for the Template.

Constraints: Allowable values are: local, git_hub, git_hub_enterprise, git_lab, ibm_git_lab, ibm_cloud_catalog, external_scm, cos_bucket

GetSchematicsActionSourceCatalog

CatalogName string: (String) name of the private catalog.
OfferingId string: (String) Id of the offering the IBM Catalog.
OfferingKind string: (String) Type of the offering, in the IBM Catalog.
OfferingName string: (String) Name of the offering in the IBM Catalog.
OfferingRepoUrl string: (String) Repo Url of the offering, in the IBM Catalog.
OfferingVersion string: (String) Version string of the offering in the IBM Catalog.
OfferingVersionId string: (String) Id of the offering version the IBM Catalog.

CatalogName string: (String) name of the private catalog.
OfferingId string: (String) Id of the offering the IBM Catalog.
OfferingKind string: (String) Type of the offering, in the IBM Catalog.
OfferingName string: (String) Name of the offering in the IBM Catalog.
OfferingRepoUrl string: (String) Repo Url of the offering, in the IBM Catalog.
OfferingVersion string: (String) Version string of the offering in the IBM Catalog.
OfferingVersionId string: (String) Id of the offering version the IBM Catalog.

catalogName String: (String) name of the private catalog.
offeringId String: (String) Id of the offering the IBM Catalog.
offeringKind String: (String) Type of the offering, in the IBM Catalog.
offeringName String: (String) Name of the offering in the IBM Catalog.
offeringRepoUrl String: (String) Repo Url of the offering, in the IBM Catalog.
offeringVersion String: (String) Version string of the offering in the IBM Catalog.
offeringVersionId String: (String) Id of the offering version the IBM Catalog.

catalogName string: (String) name of the private catalog.
offeringId string: (String) Id of the offering the IBM Catalog.
offeringKind string: (String) Type of the offering, in the IBM Catalog.
offeringName string: (String) Name of the offering in the IBM Catalog.
offeringRepoUrl string: (String) Repo Url of the offering, in the IBM Catalog.
offeringVersion string: (String) Version string of the offering in the IBM Catalog.
offeringVersionId string: (String) Id of the offering version the IBM Catalog.

catalog_name str: (String) name of the private catalog.
offering_id str: (String) Id of the offering the IBM Catalog.
offering_kind str: (String) Type of the offering, in the IBM Catalog.
offering_name str: (String) Name of the offering in the IBM Catalog.
offering_repo_url str: (String) Repo Url of the offering, in the IBM Catalog.
offering_version str: (String) Version string of the offering in the IBM Catalog.
offering_version_id str: (String) Id of the offering version the IBM Catalog.

catalogName String: (String) name of the private catalog.
offeringId String: (String) Id of the offering the IBM Catalog.
offeringKind String: (String) Type of the offering, in the IBM Catalog.
offeringName String: (String) Name of the offering in the IBM Catalog.
offeringRepoUrl String: (String) Repo Url of the offering, in the IBM Catalog.
offeringVersion String: (String) Version string of the offering in the IBM Catalog.
offeringVersionId String: (String) Id of the offering version the IBM Catalog.

GetSchematicsActionSourceGit

ComputedGitRepoUrl string: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
GitBranch string: (String) Name of the branch, used to fetch the Git Repo.
GitRelease string: (String) Name of the release tag, used to fetch the Git Repo.
GitRepoFolder string: (String) Name of the folder in the Git Repo, that contains the template.
GitRepoUrl string: (String) URL to the GIT Repo that can be used to clone the template.
GitToken string: (String) Personal Access Token to connect to Git URLs.

ComputedGitRepoUrl string: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
GitBranch string: (String) Name of the branch, used to fetch the Git Repo.
GitRelease string: (String) Name of the release tag, used to fetch the Git Repo.
GitRepoFolder string: (String) Name of the folder in the Git Repo, that contains the template.
GitRepoUrl string: (String) URL to the GIT Repo that can be used to clone the template.
GitToken string: (String) Personal Access Token to connect to Git URLs.

computedGitRepoUrl String: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch String: (String) Name of the branch, used to fetch the Git Repo.
gitRelease String: (String) Name of the release tag, used to fetch the Git Repo.
gitRepoFolder String: (String) Name of the folder in the Git Repo, that contains the template.
gitRepoUrl String: (String) URL to the GIT Repo that can be used to clone the template.
gitToken String: (String) Personal Access Token to connect to Git URLs.

computedGitRepoUrl string: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch string: (String) Name of the branch, used to fetch the Git Repo.
gitRelease string: (String) Name of the release tag, used to fetch the Git Repo.
gitRepoFolder string: (String) Name of the folder in the Git Repo, that contains the template.
gitRepoUrl string: (String) URL to the GIT Repo that can be used to clone the template.
gitToken string: (String) Personal Access Token to connect to Git URLs.

computed_git_repo_url str: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
git_branch str: (String) Name of the branch, used to fetch the Git Repo.
git_release str: (String) Name of the release tag, used to fetch the Git Repo.
git_repo_folder str: (String) Name of the folder in the Git Repo, that contains the template.
git_repo_url str: (String) URL to the GIT Repo that can be used to clone the template.
git_token str: (String) Personal Access Token to connect to Git URLs.

computedGitRepoUrl String: (String) The Complete URL which is computed by git_repo_url, git_repo_folder and branch.
gitBranch String: (String) Name of the branch, used to fetch the Git Repo.
gitRelease String: (String) Name of the release tag, used to fetch the Git Repo.
gitRepoFolder String: (String) Name of the folder in the Git Repo, that contains the template.
gitRepoUrl String: (String) URL to the GIT Repo that can be used to clone the template.
gitToken String: (String) Personal Access Token to connect to Git URLs.

GetSchematicsActionState

StatusCode string

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

StatusJobId string

(String) Job id reference for this status.

StatusMessage string

(String) Automation status message - to be displayed along with the status_code.

StatusCode string

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

StatusJobId string

(String) Job id reference for this status.

StatusMessage string

(String) Automation status message - to be displayed along with the status_code.

statusCode String

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

statusJobId String

(String) Job id reference for this status.

statusMessage String

(String) Automation status message - to be displayed along with the status_code.

statusCode string

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

statusJobId string

(String) Job id reference for this status.

statusMessage string

(String) Automation status message - to be displayed along with the status_code.

status_code str

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

status_job_id str

(String) Job id reference for this status.

status_message str

(String) Automation status message - to be displayed along with the status_code.

statusCode String

(String) Status of automation (workspace or action).

Constraints: Allowable values are: normal, pending, disabled, critical

statusJobId String

(String) Job id reference for this status.

statusMessage String

(String) Automation status message - to be displayed along with the status_code.

GetSchematicsActionSysLock

SysLocked bool: (Boolean) Is the automation locked by a Schematic job ?.
SysLockedAt string: (String) When the User performed the job that lead to locking of the automation ?.
SysLockedBy string: (String) Name of the User who performed the job, that lead to the locking of the automation.

SysLocked bool: (Boolean) Is the automation locked by a Schematic job ?.
SysLockedAt string: (String) When the User performed the job that lead to locking of the automation ?.
SysLockedBy string: (String) Name of the User who performed the job, that lead to the locking of the automation.

sysLocked Boolean: (Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt String: (String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy String: (String) Name of the User who performed the job, that lead to the locking of the automation.

sysLocked boolean: (Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt string: (String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy string: (String) Name of the User who performed the job, that lead to the locking of the automation.

sys_locked bool: (Boolean) Is the automation locked by a Schematic job ?.
sys_locked_at str: (String) When the User performed the job that lead to locking of the automation ?.
sys_locked_by str: (String) Name of the User who performed the job, that lead to the locking of the automation.

sysLocked Boolean: (Boolean) Is the automation locked by a Schematic job ?.
sysLockedAt String: (String) When the User performed the job that lead to locking of the automation ?.
sysLockedBy String: (String) Name of the User who performed the job, that lead to the locking of the automation.

GetSchematicsActionUserState

SetAt string

(String) When the User who set the state of the Object.

SetBy string

(String) Name of the User who set the state of the Object.

State string

Constraints: Allowable values are: draft, live, locked, disable

SetAt string

(String) When the User who set the state of the Object.

SetBy string

(String) Name of the User who set the state of the Object.

State string

Constraints: Allowable values are: draft, live, locked, disable

setAt String

(String) When the User who set the state of the Object.

setBy String

(String) Name of the User who set the state of the Object.

state String

Constraints: Allowable values are: draft, live, locked, disable

setAt string

(String) When the User who set the state of the Object.

setBy string

(String) Name of the User who set the state of the Object.

state string

Constraints: Allowable values are: draft, live, locked, disable

set_at str

(String) When the User who set the state of the Object.

set_by str

(String) Name of the User who set the state of the Object.

state str

Constraints: Allowable values are: draft, live, locked, disable

setAt String

(String) When the User who set the state of the Object.

setBy String

(String) Name of the User who set the state of the Object.

state String

Constraints: Allowable values are: draft, live, locked, disable

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getSchematicsAction

On this page

On this page

Example Usage

Using getSchematicsAction

getSchematicsAction Result

Supporting Types

GetSchematicsActionActionInput

GetSchematicsActionActionInputMetadata

GetSchematicsActionActionOutput

GetSchematicsActionActionOutputMetadata

GetSchematicsActionBastion

GetSchematicsActionBastionCredential

GetSchematicsActionBastionCredentialMetadata

GetSchematicsActionCredential

GetSchematicsActionCredentialMetadata

GetSchematicsActionSetting

GetSchematicsActionSettingMetadata

GetSchematicsActionSource

GetSchematicsActionSourceCatalog

GetSchematicsActionSourceGit

GetSchematicsActionState

GetSchematicsActionSysLock

GetSchematicsActionUserState

Package Details

On this page

On this page