1. Packages
  2. Awx Provider
  3. API Docs
  4. JobTemplate
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

awx.JobTemplate

Explore with Pulumi AI

awx logo
awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

    TBD

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as awx from "@pulumi/awx";
    
    const _default = awx.getInventory({
        name: "private_services",
        organizationId: data.awx_organization["default"].id,
    });
    const baseconfig = new awx.JobTemplate("baseconfig", {
        jobType: "run",
        inventoryId: _default.then(_default => _default.id),
        projectId: awx_project.base_service_config.id,
        playbook: "master-configure-system.yml",
        becomeEnabled: true,
    });
    
    import pulumi
    import pulumi_awx as awx
    
    default = awx.get_inventory(name="private_services",
        organization_id=data["awx_organization"]["default"]["id"])
    baseconfig = awx.JobTemplate("baseconfig",
        job_type="run",
        inventory_id=default.id,
        project_id=awx_project["base_service_config"]["id"],
        playbook="master-configure-system.yml",
        become_enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/awx/awx"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_default, err := awx.LookupInventory(ctx, &awx.LookupInventoryArgs{
    			Name:           pulumi.StringRef("private_services"),
    			OrganizationId: pulumi.Float64Ref(data.Awx_organization.Default.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = awx.NewJobTemplate(ctx, "baseconfig", &awx.JobTemplateArgs{
    			JobType:       pulumi.String("run"),
    			InventoryId:   pulumi.Float64(_default.Id),
    			ProjectId:     pulumi.Any(awx_project.Base_service_config.Id),
    			Playbook:      pulumi.String("master-configure-system.yml"),
    			BecomeEnabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Awx = Pulumi.Awx;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Awx.GetInventory.Invoke(new()
        {
            Name = "private_services",
            OrganizationId = data.Awx_organization.Default.Id,
        });
    
        var baseconfig = new Awx.JobTemplate("baseconfig", new()
        {
            JobType = "run",
            InventoryId = @default.Apply(@default => @default.Apply(getInventoryResult => getInventoryResult.Id)),
            ProjectId = awx_project.Base_service_config.Id,
            Playbook = "master-configure-system.yml",
            BecomeEnabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.awx.AwxFunctions;
    import com.pulumi.awx.inputs.GetInventoryArgs;
    import com.pulumi.awx.JobTemplate;
    import com.pulumi.awx.JobTemplateArgs;
    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 default = AwxFunctions.getInventory(GetInventoryArgs.builder()
                .name("private_services")
                .organizationId(data.awx_organization().default().id())
                .build());
    
            var baseconfig = new JobTemplate("baseconfig", JobTemplateArgs.builder()
                .jobType("run")
                .inventoryId(default_.id())
                .projectId(awx_project.base_service_config().id())
                .playbook("master-configure-system.yml")
                .becomeEnabled(true)
                .build());
    
        }
    }
    
    resources:
      baseconfig:
        type: awx:JobTemplate
        properties:
          jobType: run
          inventoryId: ${default.id}
          projectId: ${awx_project.base_service_config.id}
          playbook: master-configure-system.yml
          becomeEnabled: true
    variables:
      default:
        fn::invoke:
          function: awx:getInventory
          arguments:
            name: private_services
            organizationId: ${data.awx_organization.default.id}
    

    Create JobTemplate Resource

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

    Constructor syntax

    new JobTemplate(name: string, args: JobTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def JobTemplate(resource_name: str,
                    args: JobTemplateArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def JobTemplate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    inventory_id: Optional[str] = None,
                    project_id: Optional[float] = None,
                    job_type: Optional[str] = None,
                    force_handlers: Optional[bool] = None,
                    limit: Optional[str] = None,
                    ask_limit_on_launch: Optional[bool] = None,
                    ask_skip_tags_on_launch: Optional[bool] = None,
                    ask_tags_on_launch: Optional[bool] = None,
                    ask_variables_on_launch: Optional[bool] = None,
                    ask_verbosity_on_launch: Optional[bool] = None,
                    become_enabled: Optional[bool] = None,
                    custom_virtualenv: Optional[str] = None,
                    description: Optional[str] = None,
                    diff_mode: Optional[bool] = None,
                    execution_environment: Optional[str] = None,
                    extra_vars: Optional[str] = None,
                    allow_simultaneous: Optional[bool] = None,
                    ask_job_type_on_launch: Optional[bool] = None,
                    forks: Optional[float] = None,
                    playbook: Optional[str] = None,
                    job_tags: Optional[str] = None,
                    job_template_id: Optional[str] = None,
                    ask_diff_mode_on_launch: Optional[bool] = None,
                    host_config_key: Optional[str] = None,
                    name: Optional[str] = None,
                    ask_inventory_on_launch: Optional[bool] = None,
                    ask_credential_on_launch: Optional[bool] = None,
                    skip_tags: Optional[str] = None,
                    start_at_task: Optional[str] = None,
                    survey_enabled: Optional[bool] = None,
                    timeout: Optional[float] = None,
                    use_fact_cache: Optional[bool] = None,
                    verbosity: Optional[float] = None)
    func NewJobTemplate(ctx *Context, name string, args JobTemplateArgs, opts ...ResourceOption) (*JobTemplate, error)
    public JobTemplate(string name, JobTemplateArgs args, CustomResourceOptions? opts = null)
    public JobTemplate(String name, JobTemplateArgs args)
    public JobTemplate(String name, JobTemplateArgs args, CustomResourceOptions options)
    
    type: awx:JobTemplate
    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 JobTemplateArgs
    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 JobTemplateArgs
    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 JobTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobTemplateArgs
    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 jobTemplateResource = new Awx.JobTemplate("jobTemplateResource", new()
    {
        InventoryId = "string",
        ProjectId = 0,
        JobType = "string",
        ForceHandlers = false,
        Limit = "string",
        AskLimitOnLaunch = false,
        AskSkipTagsOnLaunch = false,
        AskTagsOnLaunch = false,
        AskVariablesOnLaunch = false,
        AskVerbosityOnLaunch = false,
        BecomeEnabled = false,
        CustomVirtualenv = "string",
        Description = "string",
        DiffMode = false,
        ExecutionEnvironment = "string",
        ExtraVars = "string",
        AllowSimultaneous = false,
        AskJobTypeOnLaunch = false,
        Forks = 0,
        Playbook = "string",
        JobTags = "string",
        JobTemplateId = "string",
        AskDiffModeOnLaunch = false,
        HostConfigKey = "string",
        Name = "string",
        AskInventoryOnLaunch = false,
        AskCredentialOnLaunch = false,
        SkipTags = "string",
        StartAtTask = "string",
        SurveyEnabled = false,
        Timeout = 0,
        UseFactCache = false,
        Verbosity = 0,
    });
    
    example, err := awx.NewJobTemplate(ctx, "jobTemplateResource", &awx.JobTemplateArgs{
    	InventoryId:           pulumi.String("string"),
    	ProjectId:             pulumi.Float64(0),
    	JobType:               pulumi.String("string"),
    	ForceHandlers:         pulumi.Bool(false),
    	Limit:                 pulumi.String("string"),
    	AskLimitOnLaunch:      pulumi.Bool(false),
    	AskSkipTagsOnLaunch:   pulumi.Bool(false),
    	AskTagsOnLaunch:       pulumi.Bool(false),
    	AskVariablesOnLaunch:  pulumi.Bool(false),
    	AskVerbosityOnLaunch:  pulumi.Bool(false),
    	BecomeEnabled:         pulumi.Bool(false),
    	CustomVirtualenv:      pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	DiffMode:              pulumi.Bool(false),
    	ExecutionEnvironment:  pulumi.String("string"),
    	ExtraVars:             pulumi.String("string"),
    	AllowSimultaneous:     pulumi.Bool(false),
    	AskJobTypeOnLaunch:    pulumi.Bool(false),
    	Forks:                 pulumi.Float64(0),
    	Playbook:              pulumi.String("string"),
    	JobTags:               pulumi.String("string"),
    	JobTemplateId:         pulumi.String("string"),
    	AskDiffModeOnLaunch:   pulumi.Bool(false),
    	HostConfigKey:         pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	AskInventoryOnLaunch:  pulumi.Bool(false),
    	AskCredentialOnLaunch: pulumi.Bool(false),
    	SkipTags:              pulumi.String("string"),
    	StartAtTask:           pulumi.String("string"),
    	SurveyEnabled:         pulumi.Bool(false),
    	Timeout:               pulumi.Float64(0),
    	UseFactCache:          pulumi.Bool(false),
    	Verbosity:             pulumi.Float64(0),
    })
    
    var jobTemplateResource = new JobTemplate("jobTemplateResource", JobTemplateArgs.builder()
        .inventoryId("string")
        .projectId(0)
        .jobType("string")
        .forceHandlers(false)
        .limit("string")
        .askLimitOnLaunch(false)
        .askSkipTagsOnLaunch(false)
        .askTagsOnLaunch(false)
        .askVariablesOnLaunch(false)
        .askVerbosityOnLaunch(false)
        .becomeEnabled(false)
        .customVirtualenv("string")
        .description("string")
        .diffMode(false)
        .executionEnvironment("string")
        .extraVars("string")
        .allowSimultaneous(false)
        .askJobTypeOnLaunch(false)
        .forks(0)
        .playbook("string")
        .jobTags("string")
        .jobTemplateId("string")
        .askDiffModeOnLaunch(false)
        .hostConfigKey("string")
        .name("string")
        .askInventoryOnLaunch(false)
        .askCredentialOnLaunch(false)
        .skipTags("string")
        .startAtTask("string")
        .surveyEnabled(false)
        .timeout(0)
        .useFactCache(false)
        .verbosity(0)
        .build());
    
    job_template_resource = awx.JobTemplate("jobTemplateResource",
        inventory_id="string",
        project_id=0,
        job_type="string",
        force_handlers=False,
        limit="string",
        ask_limit_on_launch=False,
        ask_skip_tags_on_launch=False,
        ask_tags_on_launch=False,
        ask_variables_on_launch=False,
        ask_verbosity_on_launch=False,
        become_enabled=False,
        custom_virtualenv="string",
        description="string",
        diff_mode=False,
        execution_environment="string",
        extra_vars="string",
        allow_simultaneous=False,
        ask_job_type_on_launch=False,
        forks=0,
        playbook="string",
        job_tags="string",
        job_template_id="string",
        ask_diff_mode_on_launch=False,
        host_config_key="string",
        name="string",
        ask_inventory_on_launch=False,
        ask_credential_on_launch=False,
        skip_tags="string",
        start_at_task="string",
        survey_enabled=False,
        timeout=0,
        use_fact_cache=False,
        verbosity=0)
    
    const jobTemplateResource = new awx.JobTemplate("jobTemplateResource", {
        inventoryId: "string",
        projectId: 0,
        jobType: "string",
        forceHandlers: false,
        limit: "string",
        askLimitOnLaunch: false,
        askSkipTagsOnLaunch: false,
        askTagsOnLaunch: false,
        askVariablesOnLaunch: false,
        askVerbosityOnLaunch: false,
        becomeEnabled: false,
        customVirtualenv: "string",
        description: "string",
        diffMode: false,
        executionEnvironment: "string",
        extraVars: "string",
        allowSimultaneous: false,
        askJobTypeOnLaunch: false,
        forks: 0,
        playbook: "string",
        jobTags: "string",
        jobTemplateId: "string",
        askDiffModeOnLaunch: false,
        hostConfigKey: "string",
        name: "string",
        askInventoryOnLaunch: false,
        askCredentialOnLaunch: false,
        skipTags: "string",
        startAtTask: "string",
        surveyEnabled: false,
        timeout: 0,
        useFactCache: false,
        verbosity: 0,
    });
    
    type: awx:JobTemplate
    properties:
        allowSimultaneous: false
        askCredentialOnLaunch: false
        askDiffModeOnLaunch: false
        askInventoryOnLaunch: false
        askJobTypeOnLaunch: false
        askLimitOnLaunch: false
        askSkipTagsOnLaunch: false
        askTagsOnLaunch: false
        askVariablesOnLaunch: false
        askVerbosityOnLaunch: false
        becomeEnabled: false
        customVirtualenv: string
        description: string
        diffMode: false
        executionEnvironment: string
        extraVars: string
        forceHandlers: false
        forks: 0
        hostConfigKey: string
        inventoryId: string
        jobTags: string
        jobTemplateId: string
        jobType: string
        limit: string
        name: string
        playbook: string
        projectId: 0
        skipTags: string
        startAtTask: string
        surveyEnabled: false
        timeout: 0
        useFactCache: false
        verbosity: 0
    

    JobTemplate 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 JobTemplate resource accepts the following input properties:

    inventoryId String
    jobType String
    One of: run, check, scan
    projectId Double
    allowSimultaneous Boolean
    askCredentialOnLaunch Boolean
    askDiffModeOnLaunch Boolean
    askInventoryOnLaunch Boolean
    askJobTypeOnLaunch Boolean
    askLimitOnLaunch Boolean
    askSkipTagsOnLaunch Boolean
    askTagsOnLaunch Boolean
    askVariablesOnLaunch Boolean
    askVerbosityOnLaunch Boolean
    becomeEnabled Boolean
    customVirtualenv String
    description String
    diffMode Boolean
    executionEnvironment String
    extraVars String
    forceHandlers Boolean
    forks Double
    hostConfigKey String
    jobTags String
    jobTemplateId String
    limit String
    name String
    playbook String
    skipTags String
    startAtTask String
    surveyEnabled Boolean
    timeout Double
    useFactCache Boolean
    verbosity Double
    One of 0,1,2,3,4,5
    inventoryId string
    jobType string
    One of: run, check, scan
    projectId number
    allowSimultaneous boolean
    askCredentialOnLaunch boolean
    askDiffModeOnLaunch boolean
    askInventoryOnLaunch boolean
    askJobTypeOnLaunch boolean
    askLimitOnLaunch boolean
    askSkipTagsOnLaunch boolean
    askTagsOnLaunch boolean
    askVariablesOnLaunch boolean
    askVerbosityOnLaunch boolean
    becomeEnabled boolean
    customVirtualenv string
    description string
    diffMode boolean
    executionEnvironment string
    extraVars string
    forceHandlers boolean
    forks number
    hostConfigKey string
    jobTags string
    jobTemplateId string
    limit string
    name string
    playbook string
    skipTags string
    startAtTask string
    surveyEnabled boolean
    timeout number
    useFactCache boolean
    verbosity number
    One of 0,1,2,3,4,5
    inventoryId String
    jobType String
    One of: run, check, scan
    projectId Number
    allowSimultaneous Boolean
    askCredentialOnLaunch Boolean
    askDiffModeOnLaunch Boolean
    askInventoryOnLaunch Boolean
    askJobTypeOnLaunch Boolean
    askLimitOnLaunch Boolean
    askSkipTagsOnLaunch Boolean
    askTagsOnLaunch Boolean
    askVariablesOnLaunch Boolean
    askVerbosityOnLaunch Boolean
    becomeEnabled Boolean
    customVirtualenv String
    description String
    diffMode Boolean
    executionEnvironment String
    extraVars String
    forceHandlers Boolean
    forks Number
    hostConfigKey String
    jobTags String
    jobTemplateId String
    limit String
    name String
    playbook String
    skipTags String
    startAtTask String
    surveyEnabled Boolean
    timeout Number
    useFactCache Boolean
    verbosity Number
    One of 0,1,2,3,4,5

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing JobTemplate Resource

    Get an existing JobTemplate 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?: JobTemplateState, opts?: CustomResourceOptions): JobTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_simultaneous: Optional[bool] = None,
            ask_credential_on_launch: Optional[bool] = None,
            ask_diff_mode_on_launch: Optional[bool] = None,
            ask_inventory_on_launch: Optional[bool] = None,
            ask_job_type_on_launch: Optional[bool] = None,
            ask_limit_on_launch: Optional[bool] = None,
            ask_skip_tags_on_launch: Optional[bool] = None,
            ask_tags_on_launch: Optional[bool] = None,
            ask_variables_on_launch: Optional[bool] = None,
            ask_verbosity_on_launch: Optional[bool] = None,
            become_enabled: Optional[bool] = None,
            custom_virtualenv: Optional[str] = None,
            description: Optional[str] = None,
            diff_mode: Optional[bool] = None,
            execution_environment: Optional[str] = None,
            extra_vars: Optional[str] = None,
            force_handlers: Optional[bool] = None,
            forks: Optional[float] = None,
            host_config_key: Optional[str] = None,
            inventory_id: Optional[str] = None,
            job_tags: Optional[str] = None,
            job_template_id: Optional[str] = None,
            job_type: Optional[str] = None,
            limit: Optional[str] = None,
            name: Optional[str] = None,
            playbook: Optional[str] = None,
            project_id: Optional[float] = None,
            skip_tags: Optional[str] = None,
            start_at_task: Optional[str] = None,
            survey_enabled: Optional[bool] = None,
            timeout: Optional[float] = None,
            use_fact_cache: Optional[bool] = None,
            verbosity: Optional[float] = None) -> JobTemplate
    func GetJobTemplate(ctx *Context, name string, id IDInput, state *JobTemplateState, opts ...ResourceOption) (*JobTemplate, error)
    public static JobTemplate Get(string name, Input<string> id, JobTemplateState? state, CustomResourceOptions? opts = null)
    public static JobTemplate get(String name, Output<String> id, JobTemplateState state, CustomResourceOptions options)
    resources:  _:    type: awx:JobTemplate    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:
    allowSimultaneous Boolean
    askCredentialOnLaunch Boolean
    askDiffModeOnLaunch Boolean
    askInventoryOnLaunch Boolean
    askJobTypeOnLaunch Boolean
    askLimitOnLaunch Boolean
    askSkipTagsOnLaunch Boolean
    askTagsOnLaunch Boolean
    askVariablesOnLaunch Boolean
    askVerbosityOnLaunch Boolean
    becomeEnabled Boolean
    customVirtualenv String
    description String
    diffMode Boolean
    executionEnvironment String
    extraVars String
    forceHandlers Boolean
    forks Double
    hostConfigKey String
    inventoryId String
    jobTags String
    jobTemplateId String
    jobType String
    One of: run, check, scan
    limit String
    name String
    playbook String
    projectId Double
    skipTags String
    startAtTask String
    surveyEnabled Boolean
    timeout Double
    useFactCache Boolean
    verbosity Double
    One of 0,1,2,3,4,5
    allowSimultaneous boolean
    askCredentialOnLaunch boolean
    askDiffModeOnLaunch boolean
    askInventoryOnLaunch boolean
    askJobTypeOnLaunch boolean
    askLimitOnLaunch boolean
    askSkipTagsOnLaunch boolean
    askTagsOnLaunch boolean
    askVariablesOnLaunch boolean
    askVerbosityOnLaunch boolean
    becomeEnabled boolean
    customVirtualenv string
    description string
    diffMode boolean
    executionEnvironment string
    extraVars string
    forceHandlers boolean
    forks number
    hostConfigKey string
    inventoryId string
    jobTags string
    jobTemplateId string
    jobType string
    One of: run, check, scan
    limit string
    name string
    playbook string
    projectId number
    skipTags string
    startAtTask string
    surveyEnabled boolean
    timeout number
    useFactCache boolean
    verbosity number
    One of 0,1,2,3,4,5
    allowSimultaneous Boolean
    askCredentialOnLaunch Boolean
    askDiffModeOnLaunch Boolean
    askInventoryOnLaunch Boolean
    askJobTypeOnLaunch Boolean
    askLimitOnLaunch Boolean
    askSkipTagsOnLaunch Boolean
    askTagsOnLaunch Boolean
    askVariablesOnLaunch Boolean
    askVerbosityOnLaunch Boolean
    becomeEnabled Boolean
    customVirtualenv String
    description String
    diffMode Boolean
    executionEnvironment String
    extraVars String
    forceHandlers Boolean
    forks Number
    hostConfigKey String
    inventoryId String
    jobTags String
    jobTemplateId String
    jobType String
    One of: run, check, scan
    limit String
    name String
    playbook String
    projectId Number
    skipTags String
    startAtTask String
    surveyEnabled Boolean
    timeout Number
    useFactCache Boolean
    verbosity Number
    One of 0,1,2,3,4,5

    Package Details

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