Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. F5bigip Provider
  3. API Docs
  4. cm
  5. Device
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.cm.Device

Explore with Pulumi AI

f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.cm.Device provides details about a specific bigip

This resource is helpful when configuring the BIG-IP device in cluster or in HA mode.

Example Usage

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

const myNewDevice = new f5bigip.cm.Device("my_new_device", {
    name: "bigip300.f5.com",
    configsyncIp: "2.2.2.2",
    mirrorIp: "10.10.10.10",
    mirrorSecondaryIp: "11.11.11.11",
});
Copy
import pulumi
import pulumi_f5bigip as f5bigip

my_new_device = f5bigip.cm.Device("my_new_device",
    name="bigip300.f5.com",
    configsync_ip="2.2.2.2",
    mirror_ip="10.10.10.10",
    mirror_secondary_ip="11.11.11.11")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cm.NewDevice(ctx, "my_new_device", &cm.DeviceArgs{
			Name:              pulumi.String("bigip300.f5.com"),
			ConfigsyncIp:      pulumi.String("2.2.2.2"),
			MirrorIp:          pulumi.String("10.10.10.10"),
			MirrorSecondaryIp: pulumi.String("11.11.11.11"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var myNewDevice = new F5BigIP.CM.Device("my_new_device", new()
    {
        Name = "bigip300.f5.com",
        ConfigsyncIp = "2.2.2.2",
        MirrorIp = "10.10.10.10",
        MirrorSecondaryIp = "11.11.11.11",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.cm.Device;
import com.pulumi.f5bigip.cm.DeviceArgs;
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 myNewDevice = new Device("myNewDevice", DeviceArgs.builder()
            .name("bigip300.f5.com")
            .configsyncIp("2.2.2.2")
            .mirrorIp("10.10.10.10")
            .mirrorSecondaryIp("11.11.11.11")
            .build());

    }
}
Copy
resources:
  myNewDevice:
    type: f5bigip:cm:Device
    name: my_new_device
    properties:
      name: bigip300.f5.com
      configsyncIp: 2.2.2.2
      mirrorIp: 10.10.10.10
      mirrorSecondaryIp: 11.11.11.11
Copy

Create Device Resource

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

Constructor syntax

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

@overload
def Device(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           configsync_ip: Optional[str] = None,
           name: Optional[str] = None,
           mirror_ip: Optional[str] = None,
           mirror_secondary_ip: Optional[str] = None)
func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)

type: f5bigip:cm:Device
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. DeviceArgs
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. DeviceArgs
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. DeviceArgs
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. DeviceArgs
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. DeviceArgs
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 deviceResource = new F5BigIP.CM.Device("deviceResource", new()
{
    ConfigsyncIp = "string",
    Name = "string",
    MirrorIp = "string",
    MirrorSecondaryIp = "string",
});
Copy
example, err := cm.NewDevice(ctx, "deviceResource", &cm.DeviceArgs{
	ConfigsyncIp:      pulumi.String("string"),
	Name:              pulumi.String("string"),
	MirrorIp:          pulumi.String("string"),
	MirrorSecondaryIp: pulumi.String("string"),
})
Copy
var deviceResource = new Device("deviceResource", DeviceArgs.builder()
    .configsyncIp("string")
    .name("string")
    .mirrorIp("string")
    .mirrorSecondaryIp("string")
    .build());
Copy
device_resource = f5bigip.cm.Device("deviceResource",
    configsync_ip="string",
    name="string",
    mirror_ip="string",
    mirror_secondary_ip="string")
Copy
const deviceResource = new f5bigip.cm.Device("deviceResource", {
    configsyncIp: "string",
    name: "string",
    mirrorIp: "string",
    mirrorSecondaryIp: "string",
});
Copy
type: f5bigip:cm:Device
properties:
    configsyncIp: string
    mirrorIp: string
    mirrorSecondaryIp: string
    name: string
Copy

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

ConfigsyncIp This property is required. string
IP address used for config sync
Name This property is required. string
Address of the Device which needs to be Deviceensed
MirrorIp string
IP address used for state mirroring
MirrorSecondaryIp string
Secondary IP address used for state mirroring
ConfigsyncIp This property is required. string
IP address used for config sync
Name This property is required. string
Address of the Device which needs to be Deviceensed
MirrorIp string
IP address used for state mirroring
MirrorSecondaryIp string
Secondary IP address used for state mirroring
configsyncIp This property is required. String
IP address used for config sync
name This property is required. String
Address of the Device which needs to be Deviceensed
mirrorIp String
IP address used for state mirroring
mirrorSecondaryIp String
Secondary IP address used for state mirroring
configsyncIp This property is required. string
IP address used for config sync
name This property is required. string
Address of the Device which needs to be Deviceensed
mirrorIp string
IP address used for state mirroring
mirrorSecondaryIp string
Secondary IP address used for state mirroring
configsync_ip This property is required. str
IP address used for config sync
name This property is required. str
Address of the Device which needs to be Deviceensed
mirror_ip str
IP address used for state mirroring
mirror_secondary_ip str
Secondary IP address used for state mirroring
configsyncIp This property is required. String
IP address used for config sync
name This property is required. String
Address of the Device which needs to be Deviceensed
mirrorIp String
IP address used for state mirroring
mirrorSecondaryIp String
Secondary IP address used for state mirroring

Outputs

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

Get an existing Device 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?: DeviceState, opts?: CustomResourceOptions): Device
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configsync_ip: Optional[str] = None,
        mirror_ip: Optional[str] = None,
        mirror_secondary_ip: Optional[str] = None,
        name: Optional[str] = None) -> Device
func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
resources:  _:    type: f5bigip:cm:Device    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:
ConfigsyncIp string
IP address used for config sync
MirrorIp string
IP address used for state mirroring
MirrorSecondaryIp string
Secondary IP address used for state mirroring
Name string
Address of the Device which needs to be Deviceensed
ConfigsyncIp string
IP address used for config sync
MirrorIp string
IP address used for state mirroring
MirrorSecondaryIp string
Secondary IP address used for state mirroring
Name string
Address of the Device which needs to be Deviceensed
configsyncIp String
IP address used for config sync
mirrorIp String
IP address used for state mirroring
mirrorSecondaryIp String
Secondary IP address used for state mirroring
name String
Address of the Device which needs to be Deviceensed
configsyncIp string
IP address used for config sync
mirrorIp string
IP address used for state mirroring
mirrorSecondaryIp string
Secondary IP address used for state mirroring
name string
Address of the Device which needs to be Deviceensed
configsync_ip str
IP address used for config sync
mirror_ip str
IP address used for state mirroring
mirror_secondary_ip str
Secondary IP address used for state mirroring
name str
Address of the Device which needs to be Deviceensed
configsyncIp String
IP address used for config sync
mirrorIp String
IP address used for state mirroring
mirrorSecondaryIp String
Secondary IP address used for state mirroring
name String
Address of the Device which needs to be Deviceensed

Package Details

Repository
f5 BIG-IP pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.
f5 BIG-IP v3.17.10 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-f5bigip