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

f5bigip.Provider

Explore with Pulumi AI

The provider type for the bigip package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             address: Optional[str] = None,
             api_retries: Optional[int] = None,
             api_timeout: Optional[int] = None,
             login_ref: Optional[str] = None,
             password: Optional[str] = None,
             port: Optional[str] = None,
             teem_disable: Optional[bool] = None,
             token_auth: Optional[bool] = None,
             token_timeout: Optional[int] = None,
             token_value: Optional[str] = None,
             trusted_cert_path: Optional[str] = None,
             username: Optional[str] = None,
             validate_certs_disable: Optional[bool] = None)
func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:f5bigip
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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 ProviderArgs
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. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Address string
Domain name/IP of the BigIP
ApiRetries int
Amount of times to retry AS3 API requests. Default: 10.
ApiTimeout int
A timeout for AS3 requests, represented as a number of seconds. Default: 60
LoginRef string
Login reference for token authentication (see BIG-IP REST docs for details)
Password string
The user's password. Leave empty if using token_value
Port string
Management Port to connect to Bigip
TeemDisable bool
If this flag set to true,sending telemetry data to TEEM will be disabled
TokenAuth bool
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
TokenTimeout int
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
TokenValue string
A token generated outside the provider, in place of password
TrustedCertPath string
Valid Trusted Certificate path
Username string
Username with API access to the BigIP
ValidateCertsDisable bool
If set to true, Disables TLS certificate check on BIG-IP. Default : True
Address string
Domain name/IP of the BigIP
ApiRetries int
Amount of times to retry AS3 API requests. Default: 10.
ApiTimeout int
A timeout for AS3 requests, represented as a number of seconds. Default: 60
LoginRef string
Login reference for token authentication (see BIG-IP REST docs for details)
Password string
The user's password. Leave empty if using token_value
Port string
Management Port to connect to Bigip
TeemDisable bool
If this flag set to true,sending telemetry data to TEEM will be disabled
TokenAuth bool
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
TokenTimeout int
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
TokenValue string
A token generated outside the provider, in place of password
TrustedCertPath string
Valid Trusted Certificate path
Username string
Username with API access to the BigIP
ValidateCertsDisable bool
If set to true, Disables TLS certificate check on BIG-IP. Default : True
address String
Domain name/IP of the BigIP
apiRetries Integer
Amount of times to retry AS3 API requests. Default: 10.
apiTimeout Integer
A timeout for AS3 requests, represented as a number of seconds. Default: 60
loginRef String
Login reference for token authentication (see BIG-IP REST docs for details)
password String
The user's password. Leave empty if using token_value
port String
Management Port to connect to Bigip
teemDisable Boolean
If this flag set to true,sending telemetry data to TEEM will be disabled
tokenAuth Boolean
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
tokenTimeout Integer
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
tokenValue String
A token generated outside the provider, in place of password
trustedCertPath String
Valid Trusted Certificate path
username String
Username with API access to the BigIP
validateCertsDisable Boolean
If set to true, Disables TLS certificate check on BIG-IP. Default : True
address string
Domain name/IP of the BigIP
apiRetries number
Amount of times to retry AS3 API requests. Default: 10.
apiTimeout number
A timeout for AS3 requests, represented as a number of seconds. Default: 60
loginRef string
Login reference for token authentication (see BIG-IP REST docs for details)
password string
The user's password. Leave empty if using token_value
port string
Management Port to connect to Bigip
teemDisable boolean
If this flag set to true,sending telemetry data to TEEM will be disabled
tokenAuth boolean
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
tokenTimeout number
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
tokenValue string
A token generated outside the provider, in place of password
trustedCertPath string
Valid Trusted Certificate path
username string
Username with API access to the BigIP
validateCertsDisable boolean
If set to true, Disables TLS certificate check on BIG-IP. Default : True
address str
Domain name/IP of the BigIP
api_retries int
Amount of times to retry AS3 API requests. Default: 10.
api_timeout int
A timeout for AS3 requests, represented as a number of seconds. Default: 60
login_ref str
Login reference for token authentication (see BIG-IP REST docs for details)
password str
The user's password. Leave empty if using token_value
port str
Management Port to connect to Bigip
teem_disable bool
If this flag set to true,sending telemetry data to TEEM will be disabled
token_auth bool
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
token_timeout int
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
token_value str
A token generated outside the provider, in place of password
trusted_cert_path str
Valid Trusted Certificate path
username str
Username with API access to the BigIP
validate_certs_disable bool
If set to true, Disables TLS certificate check on BIG-IP. Default : True
address String
Domain name/IP of the BigIP
apiRetries Number
Amount of times to retry AS3 API requests. Default: 10.
apiTimeout Number
A timeout for AS3 requests, represented as a number of seconds. Default: 60
loginRef String
Login reference for token authentication (see BIG-IP REST docs for details)
password String
The user's password. Leave empty if using token_value
port String
Management Port to connect to Bigip
teemDisable Boolean
If this flag set to true,sending telemetry data to TEEM will be disabled
tokenAuth Boolean
Enable to use token authentication. Can be set via the BIGIP_TOKEN_AUTH environment variable
tokenTimeout Number
A lifespan to request for the AS3 auth token, represented as a number of seconds. Default: 1200
tokenValue String
A token generated outside the provider, in place of password
trustedCertPath String
Valid Trusted Certificate path
username String
Username with API access to the BigIP
validateCertsDisable Boolean
If set to true, Disables TLS certificate check on BIG-IP. Default : True

Outputs

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

Package Details

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