avi.getScheduler

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Scheduler” sidebar_current: “docs-avi-datasource-scheduler” description: |- Get information of Avi Scheduler.

avi.Scheduler

This data source is used to to get avi.Scheduler objects.

Example Usage

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

const fooScheduler = avi.getScheduler({
    name: "foo",
    uuid: "scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_scheduler = avi.get_scheduler(name="foo",
    uuid="scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

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.LookupScheduler(ctx, &avi.LookupSchedulerArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		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 fooScheduler = Avi.GetScheduler.Invoke(new()
    {
        Name = "foo",
        Uuid = "scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetSchedulerArgs;
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 fooScheduler = AviFunctions.getScheduler(GetSchedulerArgs.builder()
            .name("foo")
            .uuid("scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooScheduler:
    fn::invoke:
      function: avi:getScheduler
      arguments:
        name: foo
        uuid: scheduler-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getScheduler

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

function getScheduler(args: GetSchedulerArgs, opts?: InvokeOptions): Promise<GetSchedulerResult>
function getSchedulerOutput(args: GetSchedulerOutputArgs, opts?: InvokeOptions): Output<GetSchedulerResult>

def get_scheduler(id: Optional[str] = None,
                  name: Optional[str] = None,
                  tenant_ref: Optional[str] = None,
                  uuid: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSchedulerResult
def get_scheduler_output(id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  tenant_ref: Optional[pulumi.Input[str]] = None,
                  uuid: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSchedulerResult]

func LookupScheduler(ctx *Context, args *LookupSchedulerArgs, opts ...InvokeOption) (*LookupSchedulerResult, error)
func LookupSchedulerOutput(ctx *Context, args *LookupSchedulerOutputArgs, opts ...InvokeOption) LookupSchedulerResultOutput

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

public static class GetScheduler 
{
    public static Task<GetSchedulerResult> InvokeAsync(GetSchedulerArgs args, InvokeOptions? opts = null)
    public static Output<GetSchedulerResult> Invoke(GetSchedulerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchedulerResult> getScheduler(GetSchedulerArgs args, InvokeOptions options)
public static Output<GetSchedulerResult> getScheduler(GetSchedulerArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getScheduler:getScheduler
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search Scheduler by name.
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: Search Scheduler by uuid.

Id string
Name string: Search Scheduler by name.
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: Search Scheduler by uuid.

id String
name String: Search Scheduler by name.
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: Search Scheduler by uuid.

id string
name string: Search Scheduler by name.
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: Search Scheduler by uuid.

id str
name str: Search Scheduler by name.
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: Search Scheduler by uuid.

id String
name String: Search Scheduler by name.
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: Search Scheduler by uuid.

getScheduler Result

The following output properties are available:

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<GetSchedulerConfigpbAttribute>: 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.
Id string
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.
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 []GetSchedulerConfigpbAttribute: 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.
Id string
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.
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<GetSchedulerConfigpbAttribute>: 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.
id String
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.
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 GetSchedulerConfigpbAttribute[]: 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.
id string
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.
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[GetSchedulerConfigpbAttribute]: 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.
id str
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.
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.
id String
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.
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.