1. Packages
  2. F5bigip Provider
  3. API Docs
  4. GtmDatacenter
Viewing docs for f5 BIG-IP v3.20.0
published on Wednesday, Mar 4, 2026 by Pulumi
f5bigip logo
Viewing docs for f5 BIG-IP v3.20.0
published on Wednesday, Mar 4, 2026 by Pulumi

    #<span pulumi-lang-nodejs=" f5bigip.GtmDatacenter

    " pulumi-lang-dotnet=" f5bigip.GtmDatacenter " pulumi-lang-go=" GtmDatacenter " pulumi-lang-python=" GtmDatacenter " pulumi-lang-yaml=" f5bigip.GtmDatacenter " pulumi-lang-java=" f5bigip.GtmDatacenter “> f5bigip.GtmDatacenter Manages F5 BIG-IP GTM (Global Traffic Manager) Datacenter resources.

    A GTM datacenter is a logical representation of a physical location where servers reside. Datacenters are fundamental building blocks in GTM topology and are used for geographic load balancing and disaster recovery.

    Example Usage

    Basic Datacenter

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const example = new f5bigip.GtmDatacenter("example", {
        name: "example_datacenter",
        partition: "Common",
        location: "Seattle, WA",
        contact: "admin@example.com",
        description: "Primary datacenter for west coast operations",
        enabled: true,
        proberPreference: "inside-datacenter",
        proberFallback: "any-available",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    example = f5bigip.GtmDatacenter("example",
        name="example_datacenter",
        partition="Common",
        location="Seattle, WA",
        contact="admin@example.com",
        description="Primary datacenter for west coast operations",
        enabled=True,
        prober_preference="inside-datacenter",
        prober_fallback="any-available")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := f5bigip.NewGtmDatacenter(ctx, "example", &f5bigip.GtmDatacenterArgs{
    			Name:             pulumi.String("example_datacenter"),
    			Partition:        pulumi.String("Common"),
    			Location:         pulumi.String("Seattle, WA"),
    			Contact:          pulumi.String("admin@example.com"),
    			Description:      pulumi.String("Primary datacenter for west coast operations"),
    			Enabled:          pulumi.Bool(true),
    			ProberPreference: pulumi.String("inside-datacenter"),
    			ProberFallback:   pulumi.String("any-available"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new F5BigIP.GtmDatacenter("example", new()
        {
            Name = "example_datacenter",
            Partition = "Common",
            Location = "Seattle, WA",
            Contact = "admin@example.com",
            Description = "Primary datacenter for west coast operations",
            Enabled = true,
            ProberPreference = "inside-datacenter",
            ProberFallback = "any-available",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.GtmDatacenter;
    import com.pulumi.f5bigip.GtmDatacenterArgs;
    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 example = new GtmDatacenter("example", GtmDatacenterArgs.builder()
                .name("example_datacenter")
                .partition("Common")
                .location("Seattle, WA")
                .contact("admin@example.com")
                .description("Primary datacenter for west coast operations")
                .enabled(true)
                .proberPreference("inside-datacenter")
                .proberFallback("any-available")
                .build());
    
        }
    }
    
    resources:
      example:
        type: f5bigip:GtmDatacenter
        properties:
          name: example_datacenter
          partition: Common
          location: Seattle, WA
          contact: admin@example.com
          description: Primary datacenter for west coast operations
          enabled: true
          proberPreference: inside-datacenter
          proberFallback: any-available
    

    Datacenter with Custom Prober Settings

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const customProber = new f5bigip.GtmDatacenter("custom_prober", {
        name: "custom_datacenter",
        partition: "Common",
        location: "New York, NY",
        contact: "ops@example.com",
        description: "East coast datacenter with custom prober configuration",
        enabled: true,
        proberPreference: "pool",
        proberFallback: "outside-datacenter",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    custom_prober = f5bigip.GtmDatacenter("custom_prober",
        name="custom_datacenter",
        partition="Common",
        location="New York, NY",
        contact="ops@example.com",
        description="East coast datacenter with custom prober configuration",
        enabled=True,
        prober_preference="pool",
        prober_fallback="outside-datacenter")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := f5bigip.NewGtmDatacenter(ctx, "custom_prober", &f5bigip.GtmDatacenterArgs{
    			Name:             pulumi.String("custom_datacenter"),
    			Partition:        pulumi.String("Common"),
    			Location:         pulumi.String("New York, NY"),
    			Contact:          pulumi.String("ops@example.com"),
    			Description:      pulumi.String("East coast datacenter with custom prober configuration"),
    			Enabled:          pulumi.Bool(true),
    			ProberPreference: pulumi.String("pool"),
    			ProberFallback:   pulumi.String("outside-datacenter"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var customProber = new F5BigIP.GtmDatacenter("custom_prober", new()
        {
            Name = "custom_datacenter",
            Partition = "Common",
            Location = "New York, NY",
            Contact = "ops@example.com",
            Description = "East coast datacenter with custom prober configuration",
            Enabled = true,
            ProberPreference = "pool",
            ProberFallback = "outside-datacenter",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.GtmDatacenter;
    import com.pulumi.f5bigip.GtmDatacenterArgs;
    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 customProber = new GtmDatacenter("customProber", GtmDatacenterArgs.builder()
                .name("custom_datacenter")
                .partition("Common")
                .location("New York, NY")
                .contact("ops@example.com")
                .description("East coast datacenter with custom prober configuration")
                .enabled(true)
                .proberPreference("pool")
                .proberFallback("outside-datacenter")
                .build());
    
        }
    }
    
    resources:
      customProber:
        type: f5bigip:GtmDatacenter
        name: custom_prober
        properties:
          name: custom_datacenter
          partition: Common
          location: New York, NY
          contact: ops@example.com
          description: East coast datacenter with custom prober configuration
          enabled: true
          proberPreference: pool
          proberFallback: outside-datacenter
    

    Disabled Datacenter

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const maintenance = new f5bigip.GtmDatacenter("maintenance", {
        name: "maintenance_dc",
        partition: "Common",
        location: "Chicago, IL",
        contact: "maintenance@example.com",
        description: "Datacenter currently under maintenance",
        enabled: false,
        proberPreference: "inside-datacenter",
        proberFallback: "any-available",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    maintenance = f5bigip.GtmDatacenter("maintenance",
        name="maintenance_dc",
        partition="Common",
        location="Chicago, IL",
        contact="maintenance@example.com",
        description="Datacenter currently under maintenance",
        enabled=False,
        prober_preference="inside-datacenter",
        prober_fallback="any-available")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := f5bigip.NewGtmDatacenter(ctx, "maintenance", &f5bigip.GtmDatacenterArgs{
    			Name:             pulumi.String("maintenance_dc"),
    			Partition:        pulumi.String("Common"),
    			Location:         pulumi.String("Chicago, IL"),
    			Contact:          pulumi.String("maintenance@example.com"),
    			Description:      pulumi.String("Datacenter currently under maintenance"),
    			Enabled:          pulumi.Bool(false),
    			ProberPreference: pulumi.String("inside-datacenter"),
    			ProberFallback:   pulumi.String("any-available"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var maintenance = new F5BigIP.GtmDatacenter("maintenance", new()
        {
            Name = "maintenance_dc",
            Partition = "Common",
            Location = "Chicago, IL",
            Contact = "maintenance@example.com",
            Description = "Datacenter currently under maintenance",
            Enabled = false,
            ProberPreference = "inside-datacenter",
            ProberFallback = "any-available",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.GtmDatacenter;
    import com.pulumi.f5bigip.GtmDatacenterArgs;
    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 maintenance = new GtmDatacenter("maintenance", GtmDatacenterArgs.builder()
                .name("maintenance_dc")
                .partition("Common")
                .location("Chicago, IL")
                .contact("maintenance@example.com")
                .description("Datacenter currently under maintenance")
                .enabled(false)
                .proberPreference("inside-datacenter")
                .proberFallback("any-available")
                .build());
    
        }
    }
    
    resources:
      maintenance:
        type: f5bigip:GtmDatacenter
        properties:
          name: maintenance_dc
          partition: Common
          location: Chicago, IL
          contact: maintenance@example.com
          description: Datacenter currently under maintenance
          enabled: false
          proberPreference: inside-datacenter
          proberFallback: any-available
    

    Notes

    • Datacenters are required before you can create GTM servers and pools.
    • The name and partition cannot be changed after creation. You must destroy and recreate the resource to change these values.
    • Disabling a datacenter (enabled = false) removes it from load balancing decisions but preserves its configuration.
    • Prober settings control how BIG-IP monitors the health of resources in this datacenter.

    Create GtmDatacenter Resource

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

    Constructor syntax

    new GtmDatacenter(name: string, args: GtmDatacenterArgs, opts?: CustomResourceOptions);
    @overload
    def GtmDatacenter(resource_name: str,
                      args: GtmDatacenterArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def GtmDatacenter(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      name: Optional[str] = None,
                      contact: Optional[str] = None,
                      description: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      location: Optional[str] = None,
                      partition: Optional[str] = None,
                      prober_fallback: Optional[str] = None,
                      prober_preference: Optional[str] = None)
    func NewGtmDatacenter(ctx *Context, name string, args GtmDatacenterArgs, opts ...ResourceOption) (*GtmDatacenter, error)
    public GtmDatacenter(string name, GtmDatacenterArgs args, CustomResourceOptions? opts = null)
    public GtmDatacenter(String name, GtmDatacenterArgs args)
    public GtmDatacenter(String name, GtmDatacenterArgs args, CustomResourceOptions options)
    
    type: f5bigip:GtmDatacenter
    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 GtmDatacenterArgs
    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 GtmDatacenterArgs
    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 GtmDatacenterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GtmDatacenterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GtmDatacenterArgs
    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 gtmDatacenterResource = new F5BigIP.GtmDatacenter("gtmDatacenterResource", new()
    {
        Name = "string",
        Contact = "string",
        Description = "string",
        Enabled = false,
        Location = "string",
        Partition = "string",
        ProberFallback = "string",
        ProberPreference = "string",
    });
    
    example, err := f5bigip.NewGtmDatacenter(ctx, "gtmDatacenterResource", &f5bigip.GtmDatacenterArgs{
    	Name:             pulumi.String("string"),
    	Contact:          pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Enabled:          pulumi.Bool(false),
    	Location:         pulumi.String("string"),
    	Partition:        pulumi.String("string"),
    	ProberFallback:   pulumi.String("string"),
    	ProberPreference: pulumi.String("string"),
    })
    
    var gtmDatacenterResource = new GtmDatacenter("gtmDatacenterResource", GtmDatacenterArgs.builder()
        .name("string")
        .contact("string")
        .description("string")
        .enabled(false)
        .location("string")
        .partition("string")
        .proberFallback("string")
        .proberPreference("string")
        .build());
    
    gtm_datacenter_resource = f5bigip.GtmDatacenter("gtmDatacenterResource",
        name="string",
        contact="string",
        description="string",
        enabled=False,
        location="string",
        partition="string",
        prober_fallback="string",
        prober_preference="string")
    
    const gtmDatacenterResource = new f5bigip.GtmDatacenter("gtmDatacenterResource", {
        name: "string",
        contact: "string",
        description: "string",
        enabled: false,
        location: "string",
        partition: "string",
        proberFallback: "string",
        proberPreference: "string",
    });
    
    type: f5bigip:GtmDatacenter
    properties:
        contact: string
        description: string
        enabled: false
        location: string
        name: string
        partition: string
        proberFallback: string
        proberPreference: string
    

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

    Name string
    Name of the GTM datacenter. Cannot be changed after creation.
    Contact string
    Contact information for the datacenter administrator.
    Description string
    Description of the datacenter.
    Enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    Location string
    Physical location of the datacenter. This is a free-form text field.
    Partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    ProberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    ProberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    Name string
    Name of the GTM datacenter. Cannot be changed after creation.
    Contact string
    Contact information for the datacenter administrator.
    Description string
    Description of the datacenter.
    Enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    Location string
    Physical location of the datacenter. This is a free-form text field.
    Partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    ProberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    ProberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    name String
    Name of the GTM datacenter. Cannot be changed after creation.
    contact String
    Contact information for the datacenter administrator.
    description String
    Description of the datacenter.
    enabled Boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location String
    Physical location of the datacenter. This is a free-form text field.
    partition String
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback String
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference String
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    name string
    Name of the GTM datacenter. Cannot be changed after creation.
    contact string
    Contact information for the datacenter administrator.
    description string
    Description of the datacenter.
    enabled boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location string
    Physical location of the datacenter. This is a free-form text field.
    partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    name str
    Name of the GTM datacenter. Cannot be changed after creation.
    contact str
    Contact information for the datacenter administrator.
    description str
    Description of the datacenter.
    enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location str
    Physical location of the datacenter. This is a free-form text field.
    partition str
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    prober_fallback str
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    prober_preference str
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    name String
    Name of the GTM datacenter. Cannot be changed after creation.
    contact String
    Contact information for the datacenter administrator.
    description String
    Description of the datacenter.
    enabled Boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location String
    Physical location of the datacenter. This is a free-form text field.
    partition String
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback String
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference String
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter

    Outputs

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

    Get an existing GtmDatacenter 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?: GtmDatacenterState, opts?: CustomResourceOptions): GtmDatacenter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            contact: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            partition: Optional[str] = None,
            prober_fallback: Optional[str] = None,
            prober_preference: Optional[str] = None) -> GtmDatacenter
    func GetGtmDatacenter(ctx *Context, name string, id IDInput, state *GtmDatacenterState, opts ...ResourceOption) (*GtmDatacenter, error)
    public static GtmDatacenter Get(string name, Input<string> id, GtmDatacenterState? state, CustomResourceOptions? opts = null)
    public static GtmDatacenter get(String name, Output<String> id, GtmDatacenterState state, CustomResourceOptions options)
    resources:  _:    type: f5bigip:GtmDatacenter    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:
    Contact string
    Contact information for the datacenter administrator.
    Description string
    Description of the datacenter.
    Enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    Location string
    Physical location of the datacenter. This is a free-form text field.
    Name string
    Name of the GTM datacenter. Cannot be changed after creation.
    Partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    ProberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    ProberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    Contact string
    Contact information for the datacenter administrator.
    Description string
    Description of the datacenter.
    Enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    Location string
    Physical location of the datacenter. This is a free-form text field.
    Name string
    Name of the GTM datacenter. Cannot be changed after creation.
    Partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    ProberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    ProberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    contact String
    Contact information for the datacenter administrator.
    description String
    Description of the datacenter.
    enabled Boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location String
    Physical location of the datacenter. This is a free-form text field.
    name String
    Name of the GTM datacenter. Cannot be changed after creation.
    partition String
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback String
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference String
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    contact string
    Contact information for the datacenter administrator.
    description string
    Description of the datacenter.
    enabled boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location string
    Physical location of the datacenter. This is a free-form text field.
    name string
    Name of the GTM datacenter. Cannot be changed after creation.
    partition string
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback string
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference string
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    contact str
    Contact information for the datacenter administrator.
    description str
    Description of the datacenter.
    enabled bool
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location str
    Physical location of the datacenter. This is a free-form text field.
    name str
    Name of the GTM datacenter. Cannot be changed after creation.
    partition str
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    prober_fallback str
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    prober_preference str
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter
    contact String
    Contact information for the datacenter administrator.
    description String
    Description of the datacenter.
    enabled Boolean
    Enable or disable the datacenter. Default is true. When set to false, the datacenter is disabled and will not be used for load balancing decisions.
    location String
    Physical location of the datacenter. This is a free-form text field.
    name String
    Name of the GTM datacenter. Cannot be changed after creation.
    partition String
    Partition in which to create the datacenter. Default is Common. Cannot be changed after creation.
    proberFallback String
    Specifies the type of prober to use as fallback when the preferred prober is unavailable. Default is any-available. Valid options are:

    • any-available - Use any available prober
    • inside-datacenter - Fallback to probers inside this datacenter
    • outside-datacenter - Fallback to probers outside this datacenter
    proberPreference String
    Specifies the type of prober to prefer when monitoring resources in this datacenter. Default is inside-datacenter. Valid options are:

    • inside-datacenter - Prefer probers inside this datacenter
    • outside-datacenter - Prefer probers outside this datacenter

    Import

    GTM datacenters can be imported using the full path, e.g.

    $ pulumi import f5bigip:index/gtmDatacenter:GtmDatacenter example /Common/example_datacenter
    

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

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    Viewing docs for f5 BIG-IP v3.20.0
    published on Wednesday, Mar 4, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.