1. Packages
  2. F5bigip Provider
  3. API Docs
  4. Do
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

    f5bigip.Do provides details about bigip do resource

    This resource is helpful to configure do declarative JSON on BIG-IP.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    import * as std from "@pulumi/std";
    
    const do_example = new f5bigip.Do("do-example", {
        doJson: std.file({
            input: "example.json",
        }).then(invoke => invoke.result),
        timeout: 15,
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    import pulumi_std as std
    
    do_example = f5bigip.Do("do-example",
        do_json=std.file(input="example.json").result,
        timeout=15)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
    	"github.com/pulumi/pulumi-std/sdk/v2/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeFile, err := std.File(ctx, &std.FileArgs{
    			Input: "example.json",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = f5bigip.NewDo(ctx, "do-example", &f5bigip.DoArgs{
    			DoJson:  pulumi.String(invokeFile.Result),
    			Timeout: pulumi.Int(15),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var do_example = new F5BigIP.Do("do-example", new()
        {
            DoJson = Std.File.Invoke(new()
            {
                Input = "example.json",
            }).Apply(invoke => invoke.Result),
            Timeout = 15,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.Do;
    import com.pulumi.f5bigip.DoArgs;
    import com.pulumi.std.StdFunctions;
    import com.pulumi.std.inputs.FileArgs;
    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 do_example = new Do("do-example", DoArgs.builder()
                .doJson(StdFunctions.file(FileArgs.builder()
                    .input("example.json")
                    .build()).result())
                .timeout(15)
                .build());
    
        }
    }
    
    resources:
      do-example:
        type: f5bigip:Do
        properties:
          doJson:
            fn::invoke:
              function: std:file
              arguments:
                input: example.json
              return: result
          timeout: 15
    

    Create Do Resource

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

    Constructor syntax

    new Do(name: string, args: DoArgs, opts?: CustomResourceOptions);
    @overload
    def Do(resource_name: str,
           args: DoArgs,
           opts: Optional[ResourceOptions] = None)
    
    @overload
    def Do(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           do_json: Optional[str] = None,
           bigip_address: Optional[str] = None,
           bigip_password: Optional[str] = None,
           bigip_port: Optional[str] = None,
           bigip_token_auth: Optional[bool] = None,
           bigip_user: Optional[str] = None,
           tenant_name: Optional[str] = None,
           timeout: Optional[int] = None)
    func NewDo(ctx *Context, name string, args DoArgs, opts ...ResourceOption) (*Do, error)
    public Do(string name, DoArgs args, CustomResourceOptions? opts = null)
    public Do(String name, DoArgs args)
    public Do(String name, DoArgs args, CustomResourceOptions options)
    
    type: f5bigip:Do
    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 DoArgs
    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 DoArgs
    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 DoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DoArgs
    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 doResource = new F5BigIP.Do("doResource", new()
    {
        DoJson = "string",
        BigipAddress = "string",
        BigipPassword = "string",
        BigipPort = "string",
        BigipTokenAuth = false,
        BigipUser = "string",
        Timeout = 0,
    });
    
    example, err := f5bigip.NewDo(ctx, "doResource", &f5bigip.DoArgs{
    	DoJson:         pulumi.String("string"),
    	BigipAddress:   pulumi.String("string"),
    	BigipPassword:  pulumi.String("string"),
    	BigipPort:      pulumi.String("string"),
    	BigipTokenAuth: pulumi.Bool(false),
    	BigipUser:      pulumi.String("string"),
    	Timeout:        pulumi.Int(0),
    })
    
    var doResource = new Do("doResource", DoArgs.builder()
        .doJson("string")
        .bigipAddress("string")
        .bigipPassword("string")
        .bigipPort("string")
        .bigipTokenAuth(false)
        .bigipUser("string")
        .timeout(0)
        .build());
    
    do_resource = f5bigip.Do("doResource",
        do_json="string",
        bigip_address="string",
        bigip_password="string",
        bigip_port="string",
        bigip_token_auth=False,
        bigip_user="string",
        timeout=0)
    
    const doResource = new f5bigip.Do("doResource", {
        doJson: "string",
        bigipAddress: "string",
        bigipPassword: "string",
        bigipPort: "string",
        bigipTokenAuth: false,
        bigipUser: "string",
        timeout: 0,
    });
    
    type: f5bigip:Do
    properties:
        bigipAddress: string
        bigipPassword: string
        bigipPort: string
        bigipTokenAuth: false
        bigipUser: string
        doJson: string
        timeout: 0
    

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

    DoJson string
    Name of the of the Declarative DO JSON file
    BigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    BigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipTokenAuth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    BigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    TenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    Timeout int
    DO json
    DoJson string
    Name of the of the Declarative DO JSON file
    BigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    BigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipTokenAuth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    BigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    TenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    Timeout int
    DO json
    doJson String
    Name of the of the Declarative DO JSON file
    bigipAddress String
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword String

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort String
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth Boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser String
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    tenantName String
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout Integer
    DO json
    doJson string
    Name of the of the Declarative DO JSON file
    bigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    tenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout number
    DO json
    do_json str
    Name of the of the Declarative DO JSON file
    bigip_address str
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigip_password str

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigip_port str
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigip_token_auth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigip_user str
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    tenant_name str
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout int
    DO json
    doJson String
    Name of the of the Declarative DO JSON file
    bigipAddress String
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword String

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort String
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth Boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser String
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    tenantName String
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout Number
    DO json

    Outputs

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

    Get an existing Do 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?: DoState, opts?: CustomResourceOptions): Do
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bigip_address: Optional[str] = None,
            bigip_password: Optional[str] = None,
            bigip_port: Optional[str] = None,
            bigip_token_auth: Optional[bool] = None,
            bigip_user: Optional[str] = None,
            do_json: Optional[str] = None,
            tenant_name: Optional[str] = None,
            timeout: Optional[int] = None) -> Do
    func GetDo(ctx *Context, name string, id IDInput, state *DoState, opts ...ResourceOption) (*Do, error)
    public static Do Get(string name, Input<string> id, DoState? state, CustomResourceOptions? opts = null)
    public static Do get(String name, Output<String> id, DoState state, CustomResourceOptions options)
    resources:  _:    type: f5bigip:Do    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:
    BigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    BigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipTokenAuth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    BigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    DoJson string
    Name of the of the Declarative DO JSON file
    TenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    Timeout int
    DO json
    BigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    BigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    BigipTokenAuth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    BigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    DoJson string
    Name of the of the Declarative DO JSON file
    TenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    Timeout int
    DO json
    bigipAddress String
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword String

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort String
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth Boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser String
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    doJson String
    Name of the of the Declarative DO JSON file
    tenantName String
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout Integer
    DO json
    bigipAddress string
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword string

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort string
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser string
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    doJson string
    Name of the of the Declarative DO JSON file
    tenantName string
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout number
    DO json
    bigip_address str
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigip_password str

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigip_port str
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigip_token_auth bool
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigip_user str
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    do_json str
    Name of the of the Declarative DO JSON file
    tenant_name str
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout int
    DO json
    bigipAddress String
    IP Address of BIGIP Host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipPassword String

    Password of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration

    • timeout(minutes) - (optional) timeout to keep polling DO endpoint until Bigip is provisioned by DO.( Default timeout is 20 minutes )

    Note: If we want to replace provider BIGIP with other BIGIPs details we can specify with bigip_address, bigip_user,bigip_port and bigip_password. All Must be specified in such scenario.

    Note: Delete method is not supported by DO, so terraform destroy won't delete configuration in bigip but we will set the terrform state to empty and won't throw error.

    bigipPort String
    Port number of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    bigipTokenAuth Boolean
    Enable to use an external authentication source (LDAP, TACACS, etc)
    bigipUser String
    UserName of BIGIP host to be used for this resource,this is optional parameter. whenever we specify this parameter it gets overwrite provider configuration
    doJson String
    Name of the of the Declarative DO JSON file
    tenantName String
    unique identifier for DO resource

    Deprecated: this attribute is no longer in use

    timeout Number
    DO json

    Import

    ing

    Importing Existing DO declaration onto terraform can be done by using task id as id. An example is below:

    $ terraform import bigip_do.do-example2 2543dc37-bd1a-45c1-983f-1155a81489b2
    
    • example.json - Example of DO Declarative JSON
    {
        "schemaVersion": "1.0.0",
        "class": "Device",
        "async": true,  
        "label": "my BIG-IP declaration for declarative onboarding",
        "Common": {
            "class": "Tenant",
            "hostname": "bigip.example.com",
            "myLicense": {
                "class": "License",
                "licenseType": "regKey",
                "regKey": "xxxx"
            }, 
            "admin": {
                "class": "User",
                "userType": "regular",
                "password": "xxxx",
                "shell": "bash"
            },
            "myProvisioning": {
                "class": "Provision",
                "ltm": "nominal",
                "gtm": "minimum"
            },
            "external": {
                "class": "VLAN",
                "tag": 4093,
                "mtu": 1500,
                "interfaces": [
                    {
                        "name": "1.1",
                        "tagged": true
                    }
                ],
                "cmpHash": "dst-ip"
            },
            "external-self": {
                "class": "SelfIp",
                "address": "x.x.x.x",
                "vlan": "external",
                "allowService": "default",
                "trafficGroup": "traffic-group-local-only"
            }
        
        }
    }
    
    • DO documentation - https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/composing-a-declaration.html#sample-declaration-for-a-standalone-big-ip

    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.