1. Packages
  2. F5bigip Provider
  3. API Docs
  4. Do
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi

f5bigip.Do

Explore with Pulumi AI

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 This property is required. string
The unique name of the resource.
args This property is required. DoArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DoArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DoArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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,
});
Copy
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),
})
Copy
var doResource = new Do("doResource", DoArgs.builder()
    .doJson("string")
    .bigipAddress("string")
    .bigipPassword("string")
    .bigipPort("string")
    .bigipTokenAuth(false)
    .bigipUser("string")
    .timeout(0)
    .build());
Copy
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)
Copy
const doResource = new f5bigip.Do("doResource", {
    doJson: "string",
    bigipAddress: "string",
    bigipPassword: "string",
    bigipPort: "string",
    bigipTokenAuth: false,
    bigipUser: "string",
    timeout: 0,
});
Copy
type: f5bigip:Do
properties:
    bigipAddress: string
    bigipPassword: string
    bigipPort: string
    bigipTokenAuth: false
    bigipUser: string
    doJson: string
    timeout: 0
Copy

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 This property is required. 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
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 This property is required. 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
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 This property is required. 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
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 This property is required. 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
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 This property is required. 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
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 This property is required. 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
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
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
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
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
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
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
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

Package Details

Repository
f5 BIG-IP pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.