1. Docs
  2. Reference
  3. API
  4. @pulumi/f5bigip

Package @pulumi/f5bigip

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-f5bigip repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-f5bigip repo.

var f5bigip = require("@pulumi/f5bigip");

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

Modules

Resources

Others

Resources

Resource As3

class As3 extends CustomResource

f5bigip..As3 provides details about bigip as3 resource

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

constructor

new As3(name: string, args: As3Args, opts?: pulumi.CustomResourceOptions)

Create a As3 resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: As3State, opts?: pulumi.CustomResourceOptions): As3

Get an existing As3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is As3

Returns true if the given object is an instance of As3. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property as3Json

public as3Json: pulumi.Output<string>;

Path/Filename of Declarative AS3 JSON which can be a template/json file used with builtin templatefile function (or) file function

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property tenantName

public tenantName: pulumi.Output<string>;

Name of Tenant

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Do

class Do extends CustomResource

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 fs from "fs";

const doExample = new f5bigip.Do("do-example", {
    doJson: fs.readFileSync("example.json", "utf-8"),
    tenantName: "sampleTest1",
});

constructor

new Do(name: string, args: DoArgs, opts?: pulumi.CustomResourceOptions)

Create a Do resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DoState, opts?: pulumi.CustomResourceOptions): Do

Get an existing Do resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Do

Returns true if the given object is an instance of Do. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property doJson

public doJson: pulumi.Output<string>;

Name of the of the Declarative DO JSON file

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property tenantName

public tenantName: pulumi.Output<string>;

unique identifier for DO resource

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

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.

constructor

new Provider(name: string, args: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface As3Args

interface As3Args

The set of arguments for constructing a As3 resource.

property as3Json

as3Json: pulumi.Input<string>;

Path/Filename of Declarative AS3 JSON which can be a template/json file used with builtin templatefile function (or) file function

property tenantName

tenantName: pulumi.Input<string>;

Name of Tenant

interface As3State

interface As3State

Input properties used for looking up and filtering As3 resources.

property as3Json

as3Json?: pulumi.Input<string>;

Path/Filename of Declarative AS3 JSON which can be a template/json file used with builtin templatefile function (or) file function

property tenantName

tenantName?: pulumi.Input<string>;

Name of Tenant

interface DoArgs

interface DoArgs

The set of arguments for constructing a Do resource.

property doJson

doJson: pulumi.Input<string>;

Name of the of the Declarative DO JSON file

property tenantName

tenantName: pulumi.Input<string>;

unique identifier for DO resource

interface DoState

interface DoState

Input properties used for looking up and filtering Do resources.

property doJson

doJson?: pulumi.Input<string>;

Name of the of the Declarative DO JSON file

property tenantName

tenantName?: pulumi.Input<string>;

unique identifier for DO resource

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property address

address: pulumi.Input<string>;

Domain name/IP of the BigIP

property loginRef

loginRef?: pulumi.Input<string>;

Login reference for token authentication (see BIG-IP REST docs for details)

property password

password: pulumi.Input<string>;

The user’s password

property port

port?: pulumi.Input<string>;

Management Port to connect to Bigip

property tokenAuth

tokenAuth?: pulumi.Input<boolean>;

Enable to use an external authentication source (LDAP, TACACS, etc)

property username

username: pulumi.Input<string>;

Username with API access to the BigIP