← All packages

F5 BIG-IP

Pulumi Official
Package maintained by Pulumi
v3.7.0 published on Thursday, Mar 17, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. F5 BIG-IP
  3. f5 BIG-IP
  4. BigIqAs3

BigIqAs3

f5bigip.BigIqAs3 provides details about bigiq as3 resource

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

Example Usage

using System.IO;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

class MyStack : Stack
{
    public MyStack()
    {
        // Example Usage for json file
        var exampletask = new F5BigIP.BigIqAs3("exampletask", new F5BigIP.BigIqAs3Args
        {
            As3Json = File.ReadAllText("bigiq_example.json"),
            BigiqAddress = "xx.xx.xxx.xx",
            BigiqPassword = "xxxxxxxxx",
            BigiqUser = "xxxxx",
        });
    }

}

package main

import (
	"io/ioutil"

	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := f5bigip.NewBigIqAs3(ctx, "exampletask", &f5bigip.BigIqAs3Args{
			As3Json:       readFileOrPanic("bigiq_example.json"),
			BigiqAddress:  pulumi.String("xx.xx.xxx.xx"),
			BigiqPassword: pulumi.String("xxxxxxxxx"),
			BigiqUser:     pulumi.String("xxxxx"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_f5bigip as f5bigip

# Example Usage for json file
exampletask = f5bigip.BigIqAs3("exampletask",
    as3_json=(lambda path: open(path).read())("bigiq_example.json"),
    bigiq_address="xx.xx.xxx.xx",
    bigiq_password="xxxxxxxxx",
    bigiq_user="xxxxx")

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

// Example Usage for json file
const exampletask = new f5bigip.BigIqAs3("exampletask", {
    as3Json: fs.readFileSync("bigiq_example.json", "utf-8"),
    bigiqAddress: "xx.xx.xxx.xx",
    bigiqPassword: "xxxxxxxxx",
    bigiqUser: "xxxxx",
});

Coming soon!

Create a BigIqAs3 Resource

new BigIqAs3(name: string, args: BigIqAs3Args, opts?: CustomResourceOptions);
@overload
def BigIqAs3(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             as3_json: Optional[str] = None,
             bigiq_address: Optional[str] = None,
             bigiq_login_ref: Optional[str] = None,
             bigiq_password: Optional[str] = None,
             bigiq_port: Optional[str] = None,
             bigiq_token_auth: Optional[bool] = None,
             bigiq_user: Optional[str] = None,
             ignore_metadata: Optional[bool] = None,
             tenant_list: Optional[str] = None)
@overload
def BigIqAs3(resource_name: str,
             args: BigIqAs3Args,
             opts: Optional[ResourceOptions] = None)
func NewBigIqAs3(ctx *Context, name string, args BigIqAs3Args, opts ...ResourceOption) (*BigIqAs3, error)
public BigIqAs3(string name, BigIqAs3Args args, CustomResourceOptions? opts = null)
public BigIqAs3(String name, BigIqAs3Args args)
public BigIqAs3(String name, BigIqAs3Args args, CustomResourceOptions options)

type: f5bigip:BigIqAs3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BigIqAs3Args
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 BigIqAs3Args
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 BigIqAs3Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BigIqAs3Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BigIqAs3Args
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

BigIqAs3 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The BigIqAs3 resource accepts the following input properties:

As3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

BigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

BigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

BigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

BigiqLoginRef string

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

BigiqPort string

The registration key pool to use

BigiqTokenAuth bool

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

IgnoreMetadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

TenantList string

Name of Tenant

As3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

BigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

BigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

BigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

BigiqLoginRef string

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

BigiqPort string

The registration key pool to use

BigiqTokenAuth bool

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

IgnoreMetadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

TenantList string

Name of Tenant

as3Json String

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress String

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqPassword String

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqUser String

User name of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef String

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

bigiqPort String

The registration key pool to use

bigiqTokenAuth Boolean

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

ignoreMetadata Boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList String

Name of Tenant

as3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef string

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

bigiqPort string

The registration key pool to use

bigiqTokenAuth boolean

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

ignoreMetadata boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList string

Name of Tenant

as3_json str

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiq_address str

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiq_password str

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiq_user str

User name of the BIG-IQ to which your targer BIG-IP is attached

bigiq_login_ref str

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

bigiq_port str

The registration key pool to use

bigiq_token_auth bool

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

ignore_metadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

tenant_list str

Name of Tenant

as3Json String

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress String

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqPassword String

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqUser String

User name of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef String

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

bigiqPort String

The registration key pool to use

bigiqTokenAuth Boolean

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

ignoreMetadata Boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList String

Name of Tenant

Outputs

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

Get an existing BigIqAs3 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?: BigIqAs3State, opts?: CustomResourceOptions): BigIqAs3
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        as3_json: Optional[str] = None,
        bigiq_address: Optional[str] = None,
        bigiq_login_ref: Optional[str] = None,
        bigiq_password: Optional[str] = None,
        bigiq_port: Optional[str] = None,
        bigiq_token_auth: Optional[bool] = None,
        bigiq_user: Optional[str] = None,
        ignore_metadata: Optional[bool] = None,
        tenant_list: Optional[str] = None) -> BigIqAs3
func GetBigIqAs3(ctx *Context, name string, id IDInput, state *BigIqAs3State, opts ...ResourceOption) (*BigIqAs3, error)
public static BigIqAs3 Get(string name, Input<string> id, BigIqAs3State? state, CustomResourceOptions? opts = null)
public static BigIqAs3 get(String name, Output<String> id, BigIqAs3State state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
As3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

BigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

BigiqLoginRef string

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

BigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

BigiqPort string

The registration key pool to use

BigiqTokenAuth bool

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

BigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

IgnoreMetadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

TenantList string

Name of Tenant

As3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

BigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

BigiqLoginRef string

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

BigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

BigiqPort string

The registration key pool to use

BigiqTokenAuth bool

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

BigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

IgnoreMetadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

TenantList string

Name of Tenant

as3Json String

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress String

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef String

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

bigiqPassword String

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqPort String

The registration key pool to use

bigiqTokenAuth Boolean

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

bigiqUser String

User name of the BIG-IQ to which your targer BIG-IP is attached

ignoreMetadata Boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList String

Name of Tenant

as3Json string

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress string

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef string

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

bigiqPassword string

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqPort string

The registration key pool to use

bigiqTokenAuth boolean

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

bigiqUser string

User name of the BIG-IQ to which your targer BIG-IP is attached

ignoreMetadata boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList string

Name of Tenant

as3_json str

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiq_address str

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiq_login_ref str

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

bigiq_password str

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiq_port str

The registration key pool to use

bigiq_token_auth bool

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

bigiq_user str

User name of the BIG-IQ to which your targer BIG-IP is attached

ignore_metadata bool

Set True if you want to ignore metadata changes during update. By default it is set to true

tenant_list str

Name of Tenant

as3Json String

Path/Filename of Declarative AS3 JSON which is a json file used with builtin file function

bigiqAddress String

Address of the BIG-IQ to which your targer BIG-IP is attached

bigiqLoginRef String

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

bigiqPassword String

Password of the BIG-IQ to which your targer BIG-IP is attached

bigiqPort String

The registration key pool to use

bigiqTokenAuth Boolean

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

bigiqUser String

User name of the BIG-IQ to which your targer BIG-IP is attached

ignoreMetadata Boolean

Set True if you want to ignore metadata changes during update. By default it is set to true

tenantList String

Name of Tenant

Package Details

Repository
https://github.com/pulumi/pulumi-f5bigip
License
Apache-2.0
Notes

This Pulumi package is based on the bigip Terraform Provider.