Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Scheduler
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Scheduler

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi: avi.Scheduler” sidebar_current: “docs-avi-resource-scheduler” description: |- Creates and manages Avi Scheduler.

    avi.Scheduler

    The Scheduler resource allows the creation and management of Avi Scheduler

    Example Usage

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

const foo = new avi.Scheduler("foo", {tenantRef: "/api/tenant/?name=admin"});

    import pulumi
import pulumi_avi as avi

foo = avi.Scheduler("foo", tenant_ref="/api/tenant/?name=admin")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewScheduler(ctx, "foo", &avi.SchedulerArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Scheduler("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Scheduler;
import com.pulumi.avi.SchedulerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var foo = new Scheduler("foo", SchedulerArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

    resources:
  foo:
    type: avi:Scheduler
    properties:
      tenantRef: /api/tenant/?name=admin

    Create Scheduler Resource

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

    Constructor syntax

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

@overload
def Scheduler(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              backup_config_ref: Optional[str] = None,
              configpb_attributes: Optional[Sequence[SchedulerConfigpbAttributeArgs]] = None,
              enabled: Optional[str] = None,
              end_date_time: Optional[str] = None,
              frequency: Optional[str] = None,
              frequency_unit: Optional[str] = None,
              name: Optional[str] = None,
              run_mode: Optional[str] = None,
              run_script_ref: Optional[str] = None,
              scheduler_action: Optional[str] = None,
              scheduler_id: Optional[str] = None,
              start_date_time: Optional[str] = None,
              tenant_ref: Optional[str] = None,
              uuid: Optional[str] = None)
    func NewScheduler(ctx *Context, name string, args *SchedulerArgs, opts ...ResourceOption) (*Scheduler, error)
    public Scheduler(string name, SchedulerArgs? args = null, CustomResourceOptions? opts = null)
    public Scheduler(String name, SchedulerArgs args)
public Scheduler(String name, SchedulerArgs args, CustomResourceOptions options)

    type: avi:Scheduler
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 SchedulerArgs
    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 SchedulerArgs
    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 SchedulerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchedulerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchedulerArgs
    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 schedulerResource = new Avi.Scheduler("schedulerResource", new()
{
    BackupConfigRef = "string",
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.SchedulerConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    Enabled = "string",
    EndDateTime = "string",
    Frequency = "string",
    FrequencyUnit = "string",
    Name = "string",
    RunMode = "string",
    RunScriptRef = "string",
    SchedulerAction = "string",
    SchedulerId = "string",
    StartDateTime = "string",
    TenantRef = "string",
    Uuid = "string",
});

    example, err := avi.NewScheduler(ctx, "schedulerResource", &avi.SchedulerArgs{
	BackupConfigRef: pulumi.String("string"),
	ConfigpbAttributes: avi.SchedulerConfigpbAttributeArray{
		&avi.SchedulerConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	Enabled:         pulumi.String("string"),
	EndDateTime:     pulumi.String("string"),
	Frequency:       pulumi.String("string"),
	FrequencyUnit:   pulumi.String("string"),
	Name:            pulumi.String("string"),
	RunMode:         pulumi.String("string"),
	RunScriptRef:    pulumi.String("string"),
	SchedulerAction: pulumi.String("string"),
	SchedulerId:     pulumi.String("string"),
	StartDateTime:   pulumi.String("string"),
	TenantRef:       pulumi.String("string"),
	Uuid:            pulumi.String("string"),
})

    var schedulerResource = new Scheduler("schedulerResource", SchedulerArgs.builder()
    .backupConfigRef("string")
    .configpbAttributes(SchedulerConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .enabled("string")
    .endDateTime("string")
    .frequency("string")
    .frequencyUnit("string")
    .name("string")
    .runMode("string")
    .runScriptRef("string")
    .schedulerAction("string")
    .schedulerId("string")
    .startDateTime("string")
    .tenantRef("string")
    .uuid("string")
    .build());

    scheduler_resource = avi.Scheduler("schedulerResource",
    backup_config_ref="string",
    configpb_attributes=[{
        "version": "string",
    }],
    enabled="string",
    end_date_time="string",
    frequency="string",
    frequency_unit="string",
    name="string",
    run_mode="string",
    run_script_ref="string",
    scheduler_action="string",
    scheduler_id="string",
    start_date_time="string",
    tenant_ref="string",
    uuid="string")

    const schedulerResource = new avi.Scheduler("schedulerResource", {
    backupConfigRef: "string",
    configpbAttributes: [{
        version: "string",
    }],
    enabled: "string",
    endDateTime: "string",
    frequency: "string",
    frequencyUnit: "string",
    name: "string",
    runMode: "string",
    runScriptRef: "string",
    schedulerAction: "string",
    schedulerId: "string",
    startDateTime: "string",
    tenantRef: "string",
    uuid: "string",
});

    type: avi:Scheduler
properties:
    backupConfigRef: string
    configpbAttributes:
        - version: string
    enabled: string
    endDateTime: string
    frequency: string
    frequencyUnit: string
    name: string
    runMode: string
    runScriptRef: string
    schedulerAction: string
    schedulerId: string
    startDateTime: string
    tenantRef: string
    uuid: string

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

    BackupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<SchedulerConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EndDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FrequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerId string
    StartDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []SchedulerConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EndDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FrequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerId string
    StartDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<SchedulerConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime String
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency String
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit String
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode String
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef String
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction String
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId String
    startDateTime String
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes SchedulerConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId string
    startDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref str
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[SchedulerConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    end_date_time str
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency str
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency_unit str
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    run_mode str
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    run_script_ref str
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_action str
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_id str
    start_date_time str
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime String
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency String
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit String
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode String
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef String
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction String
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId String
    startDateTime String
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Scheduler 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 Scheduler Resource

    Get an existing Scheduler 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?: SchedulerState, opts?: CustomResourceOptions): Scheduler
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_config_ref: Optional[str] = None,
        configpb_attributes: Optional[Sequence[SchedulerConfigpbAttributeArgs]] = None,
        enabled: Optional[str] = None,
        end_date_time: Optional[str] = None,
        frequency: Optional[str] = None,
        frequency_unit: Optional[str] = None,
        name: Optional[str] = None,
        run_mode: Optional[str] = None,
        run_script_ref: Optional[str] = None,
        scheduler_action: Optional[str] = None,
        scheduler_id: Optional[str] = None,
        start_date_time: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Scheduler
    func GetScheduler(ctx *Context, name string, id IDInput, state *SchedulerState, opts ...ResourceOption) (*Scheduler, error)
    public static Scheduler Get(string name, Input<string> id, SchedulerState? state, CustomResourceOptions? opts = null)
    public static Scheduler get(String name, Output<String> id, SchedulerState state, CustomResourceOptions options)
    resources:  _:    type: avi:Scheduler    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:
    BackupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes List<SchedulerConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EndDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FrequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerId string
    StartDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    BackupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []SchedulerConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    EndDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    FrequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    RunScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    SchedulerId string
    StartDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<SchedulerConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime String
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency String
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit String
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode String
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef String
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction String
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId String
    startDateTime String
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef string
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes SchedulerConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime string
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency string
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit string
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode string
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef string
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction string
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId string
    startDateTime string
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backup_config_ref str
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[SchedulerConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    end_date_time str
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency str
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency_unit str
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    run_mode str
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    run_script_ref str
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_action str
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    scheduler_id str
    start_date_time str
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    backupConfigRef String
    Backup configuration to be executed by this scheduler. It is a reference to an object of type backupconfiguration. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    enabled String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    endDateTime String
    Scheduler end date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequency String
    Frequency at which custom scheduler will run. Allowed values are 0-60. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    frequencyUnit String
    Unit at which custom scheduler will run. Enum options - SCHEDULER_FREQUENCY_UNIT_MIN, SCHEDULER_FREQUENCY_UNIT_HOUR, SCHEDULER_FREQUENCY_UNIT_DAY, SCHEDULER_FREQUENCY_UNIT_WEEK, SCHEDULER_FREQUENCY_UNIT_MONTH. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of scheduler. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runMode String
    Scheduler run mode. Enum options - RUN_MODE_PERIODIC, RUN_MODE_AT, RUN_MODE_NOW. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    runScriptRef String
    Control script to be executed by this scheduler. It is a reference to an object of type alertscriptconfig. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerAction String
    Define scheduler action. Enum options - SCHEDULER_ACTION_RUN_A_SCRIPT, SCHEDULER_ACTION_BACKUP. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    schedulerId String
    startDateTime String
    Scheduler start date and time. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    SchedulerConfigpbAttribute, SchedulerConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version String

    Package Details

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